Programmable Voice

Twilio

Menu

Expand
Rate this page:

Media Streams

Start/Stop Media Streams

The Media Stream Resource allows you to start a stream on a phone call and send that stream to a secure websocket URL or one of the available partners via the streams connector configuration. You can also stop streams started via the <Start><Stream> TwiML instruction.

Connectors are configured via the Marketplace Add-on in the Twilio Stream Connectors Console page. Connectors cannot be configured outside of the console via TwiML. This requirement is in place to ensure that the credentials needed to send the stream to a partner are stored securely.

Any communication issues encountered while streaming media to the partner will be reported in the Twilio Debugger with additional information about the failure.

There are a maximum of 4 forked streams allowed per call. Media Streams by default uses 2 forked streams for both the inbound and outbound tracks.

Resource Properties in REST API format
sid
sid<MZ> Not PII

The SID of the Stream resource.
account_sid
sid<AC> Not PII

The SID of the Account that created this Stream resource.
call_sid
sid<CA> Not PII

The SID of the Call the Stream resource is associated with.
name
string Not PII

The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream.
status
enum:status Not PII

The status - one of stopped, in-progress
date_updated
date_time<rfc2822> Not PII

The date and time in GMT that this resource was last updated, specified in RFC 2822 format.
uri
uri Not PII

The URI of the resource, relative to https://api.twilio.com.

 
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Stream.json

Create a Stream resource

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams.json
Parameters
Parameters in REST API format
account_sid
Path
post sid<AC> Not PII

The SID of the Account that created this Stream resource.
call_sid
Path
post sid<CA> Not PII

The SID of the Call the Stream resource is associated with.
url
Required
post url Not PII

Relative or absolute url where WebSocket connection will be established.
name
Optional
post string Not PII

The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream.
track
Optional
post ienum:track Not PII

One of inbound_track, outbound_track, both_tracks.
status_callback
Optional
post url Not PII

Absolute URL of the status callback.
status_callback_method
Optional
post http_method Not PII

The http method for the status_callback (one of GET, POST).
parameter1.name
Optional
post string Not PII

Parameter name
parameter1.value
Optional
post string Not PII

Parameter value
parameter2.name
Optional
post string Not PII

Parameter name
parameter2.value
Optional
post string Not PII

Parameter value
parameter3.name
Optional
post string Not PII

Parameter name
parameter3.value
Optional
post string Not PII

Parameter value
parameter4.name
Optional
post string Not PII

Parameter name
parameter4.value
Optional
post string Not PII

Parameter value
parameter5.name
Optional
post string Not PII

Parameter name
parameter5.value
Optional
post string Not PII

Parameter value
parameter6.name
Optional
post string Not PII

Parameter name
parameter6.value
Optional
post string Not PII

Parameter value
parameter7.name
Optional
post string Not PII

Parameter name
parameter7.value
Optional
post string Not PII

Parameter value
parameter8.name
Optional
post string Not PII

Parameter name
parameter8.value
Optional
post string Not PII

Parameter value
parameter9.name
Optional
post string Not PII

Parameter name
parameter9.value
Optional
post string Not PII

Parameter value
parameter10.name
Optional
post string Not PII

Parameter name
parameter10.value
Optional
post string Not PII

Parameter value
parameter11.name
Optional
post string Not PII

Parameter name
parameter11.value
Optional
post string Not PII

Parameter value
parameter12.name
Optional
post string Not PII

Parameter name
parameter12.value
Optional
post string Not PII

Parameter value
parameter13.name
Optional
post string Not PII

Parameter name
parameter13.value
Optional
post string Not PII

Parameter value
parameter14.name
Optional
post string Not PII

Parameter name
parameter14.value
Optional
post string Not PII

Parameter value
parameter15.name
Optional
post string Not PII

Parameter name
parameter15.value
Optional
post string Not PII

Parameter value
parameter16.name
Optional
post string Not PII

Parameter name
parameter16.value
Optional
post string Not PII

Parameter value
parameter17.name
Optional
post string Not PII

Parameter name
parameter17.value
Optional
post string Not PII

Parameter value
parameter18.name
Optional
post string Not PII

Parameter name
parameter18.value
Optional
post string Not PII

Parameter value
parameter19.name
Optional
post string Not PII

Parameter name
parameter19.value
Optional
post string Not PII

Parameter value
parameter20.name
Optional
post string Not PII

Parameter name
parameter20.value
Optional
post string Not PII

Parameter value
parameter21.name
Optional
post string Not PII

Parameter name
parameter21.value
Optional
post string Not PII

Parameter value
parameter22.name
Optional
post string Not PII

Parameter name
parameter22.value
Optional
post string Not PII

Parameter value
parameter23.name
Optional
post string Not PII

Parameter name
parameter23.value
Optional
post string Not PII

Parameter value
parameter24.name
Optional
post string Not PII

Parameter name
parameter24.value
Optional
post string Not PII

Parameter value
parameter25.name
Optional
post string Not PII

Parameter name
parameter25.value
Optional
post string Not PII

Parameter value
parameter26.name
Optional
post string Not PII

Parameter name
parameter26.value
Optional
post string Not PII

Parameter value
parameter27.name
Optional
post string Not PII

Parameter name
parameter27.value
Optional
post string Not PII

Parameter value
parameter28.name
Optional
post string Not PII

Parameter name
parameter28.value
Optional
post string Not PII

Parameter value
parameter29.name
Optional
post string Not PII

Parameter name
parameter29.value
Optional
post string Not PII

Parameter value
parameter30.name
Optional
post string Not PII

Parameter name
parameter30.value
Optional
post string Not PII

Parameter value
parameter31.name
Optional
post string Not PII

Parameter name
parameter31.value
Optional
post string Not PII

Parameter value
parameter32.name
Optional
post string Not PII

Parameter name
parameter32.value
Optional
post string Not PII

Parameter value
parameter33.name
Optional
post string Not PII

Parameter name
parameter33.value
Optional
post string Not PII

Parameter value
parameter34.name
Optional
post string Not PII

Parameter name
parameter34.value
Optional
post string Not PII

Parameter value
parameter35.name
Optional
post string Not PII

Parameter name
parameter35.value
Optional
post string Not PII

Parameter value
parameter36.name
Optional
post string Not PII

Parameter name
parameter36.value
Optional
post string Not PII

Parameter value
parameter37.name
Optional
post string Not PII

Parameter name
parameter37.value
Optional
post string Not PII

Parameter value
parameter38.name
Optional
post string Not PII

Parameter name
parameter38.value
Optional
post string Not PII

Parameter value
parameter39.name
Optional
post string Not PII

Parameter name
parameter39.value
Optional
post string Not PII

Parameter value
parameter40.name
Optional
post string Not PII

Parameter name
parameter40.value
Optional
post string Not PII

Parameter value
parameter41.name
Optional
post string Not PII

Parameter name
parameter41.value
Optional
post string Not PII

Parameter value
parameter42.name
Optional
post string Not PII

Parameter name
parameter42.value
Optional
post string Not PII

Parameter value
parameter43.name
Optional
post string Not PII

Parameter name
parameter43.value
Optional
post string Not PII

Parameter value
parameter44.name
Optional
post string Not PII

Parameter name
parameter44.value
Optional
post string Not PII

Parameter value
parameter45.name
Optional
post string Not PII

Parameter name
parameter45.value
Optional
post string Not PII

Parameter value
parameter46.name
Optional
post string Not PII

Parameter name
parameter46.value
Optional
post string Not PII

Parameter value
parameter47.name
Optional
post string Not PII

Parameter name
parameter47.value
Optional
post string Not PII

Parameter value
parameter48.name
Optional
post string Not PII

Parameter name
parameter48.value
Optional
post string Not PII

Parameter value
parameter49.name
Optional
post string Not PII

Parameter name
parameter49.value
Optional
post string Not PII

Parameter value
parameter50.name
Optional
post string Not PII

Parameter name
parameter50.value
Optional
post string Not PII

Parameter value
parameter51.name
Optional
post string Not PII

Parameter name
parameter51.value
Optional
post string Not PII

Parameter value
parameter52.name
Optional
post string Not PII

Parameter name
parameter52.value
Optional
post string Not PII

Parameter value
parameter53.name
Optional
post string Not PII

Parameter name
parameter53.value
Optional
post string Not PII

Parameter value
parameter54.name
Optional
post string Not PII

Parameter name
parameter54.value
Optional
post string Not PII

Parameter value
parameter55.name
Optional
post string Not PII

Parameter name
parameter55.value
Optional
post string Not PII

Parameter value
parameter56.name
Optional
post string Not PII

Parameter name
parameter56.value
Optional
post string Not PII

Parameter value
parameter57.name
Optional
post string Not PII

Parameter name
parameter57.value
Optional
post string Not PII

Parameter value
parameter58.name
Optional
post string Not PII

Parameter name
parameter58.value
Optional
post string Not PII

Parameter value
parameter59.name
Optional
post string Not PII

Parameter name
parameter59.value
Optional
post string Not PII

Parameter value
parameter60.name
Optional
post string Not PII

Parameter name
parameter60.value
Optional
post string Not PII

Parameter value
parameter61.name
Optional
post string Not PII

Parameter name
parameter61.value
Optional
post string Not PII

Parameter value
parameter62.name
Optional
post string Not PII

Parameter name
parameter62.value
Optional
post string Not PII

Parameter value
parameter63.name
Optional
post string Not PII

Parameter name
parameter63.value
Optional
post string Not PII

Parameter value
parameter64.name
Optional
post string Not PII

Parameter name
parameter64.value
Optional
post string Not PII

Parameter value
parameter65.name
Optional
post string Not PII

Parameter name
parameter65.value
Optional
post string Not PII

Parameter value
parameter66.name
Optional
post string Not PII

Parameter name
parameter66.value
Optional
post string Not PII

Parameter value
parameter67.name
Optional
post string Not PII

Parameter name
parameter67.value
Optional
post string Not PII

Parameter value
parameter68.name
Optional
post string Not PII

Parameter name
parameter68.value
Optional
post string Not PII

Parameter value
parameter69.name
Optional
post string Not PII

Parameter name
parameter69.value
Optional
post string Not PII

Parameter value
parameter70.name
Optional
post string Not PII

Parameter name
parameter70.value
Optional
post string Not PII

Parameter value
parameter71.name
Optional
post string Not PII

Parameter name
parameter71.value
Optional
post string Not PII

Parameter value
parameter72.name
Optional
post string Not PII

Parameter name
parameter72.value
Optional
post string Not PII

Parameter value
parameter73.name
Optional
post string Not PII

Parameter name
parameter73.value
Optional
post string Not PII

Parameter value
parameter74.name
Optional
post string Not PII

Parameter name
parameter74.value
Optional
post string Not PII

Parameter value
parameter75.name
Optional
post string Not PII

Parameter name
parameter75.value
Optional
post string Not PII

Parameter value
parameter76.name
Optional
post string Not PII

Parameter name
parameter76.value
Optional
post string Not PII

Parameter value
parameter77.name
Optional
post string Not PII

Parameter name
parameter77.value
Optional
post string Not PII

Parameter value
parameter78.name
Optional
post string Not PII

Parameter name
parameter78.value
Optional
post string Not PII

Parameter value
parameter79.name
Optional
post string Not PII

Parameter name
parameter79.value
Optional
post string Not PII

Parameter value
parameter80.name
Optional
post string Not PII

Parameter name
parameter80.value
Optional
post string Not PII

Parameter value
parameter81.name
Optional
post string Not PII

Parameter name
parameter81.value
Optional
post string Not PII

Parameter value
parameter82.name
Optional
post string Not PII

Parameter name
parameter82.value
Optional
post string Not PII

Parameter value
parameter83.name
Optional
post string Not PII

Parameter name
parameter83.value
Optional
post string Not PII

Parameter value
parameter84.name
Optional
post string Not PII

Parameter name
parameter84.value
Optional
post string Not PII

Parameter value
parameter85.name
Optional
post string Not PII

Parameter name
parameter85.value
Optional
post string Not PII

Parameter value
parameter86.name
Optional
post string Not PII

Parameter name
parameter86.value
Optional
post string Not PII

Parameter value
parameter87.name
Optional
post string Not PII

Parameter name
parameter87.value
Optional
post string Not PII

Parameter value
parameter88.name
Optional
post string Not PII

Parameter name
parameter88.value
Optional
post string Not PII

Parameter value
parameter89.name
Optional
post string Not PII

Parameter name
parameter89.value
Optional
post string Not PII

Parameter value
parameter90.name
Optional
post string Not PII

Parameter name
parameter90.value
Optional
post string Not PII

Parameter value
parameter91.name
Optional
post string Not PII

Parameter name
parameter91.value
Optional
post string Not PII

Parameter value
parameter92.name
Optional
post string Not PII

Parameter name
parameter92.value
Optional
post string Not PII

Parameter value
parameter93.name
Optional
post string Not PII

Parameter name
parameter93.value
Optional
post string Not PII

Parameter value
parameter94.name
Optional
post string Not PII

Parameter name
parameter94.value
Optional
post string Not PII

Parameter value
parameter95.name
Optional
post string Not PII

Parameter name
parameter95.value
Optional
post string Not PII

Parameter value
parameter96.name
Optional
post string Not PII

Parameter name
parameter96.value
Optional
post string Not PII

Parameter value
parameter97.name
Optional
post string Not PII

Parameter name
parameter97.value
Optional
post string Not PII

Parameter value
parameter98.name
Optional
post string Not PII

Parameter name
parameter98.value
Optional
post string Not PII

Parameter value
parameter99.name
Optional
post string Not PII

Parameter name
parameter99.value
Optional
post string Not PII

Parameter value
Example 1
Loading Code Sample...
 
        

        


        

        


        


        

        

        

        

        

        

        

        

        

        

        
          Start Media Stream
        
        

        

        

        

        

        

        Example 2
        

        

        

        

        

        

        

        


        Loading Code Sample...
        

        
        


        

          

          

            

              

              

              

              

              






              

              

              


              

              


              


              

              

              

              

              

              

              

              

              

              

              
          Start Media Stream with Parameters
        
              

              

              

              

              

              

              Example 3
              

              

              

              

              

              

              

              


              Loading Code Sample...
              

              
              


              

                

                

                  

                    

                    

                    

                    

                    






                    

                    

                    


                    

                    


                    


                    

                    

                    

                    

                    

                    

                    

                    

                    

                    

                    
          Stop Media Stream
        
                    

                    

                    

                    

                    

                    

                    

                    

                    

                    
Rate this page:

                    











                    

                    

                    

                    

                    

                    

                    Need some help?
                    

                    
      We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
  
                    

                    


                    

                    

                    

                    

                    

                    


                    Loading Code Sample...
                    

                    
                    



                    

                      

                      

                        

                          

                          

                          

                          

                          






                          

                          

                          
Next Sample

                          

                          


                          


                          

                          

                          

                          

                          






                          Thank you for your feedback!
                          

                          
  Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                          









                          

                          

                          



                          

                          



                          

                          



                          

                          



                          

                          



                          

                          

                          

                          



                          

                          



                          

                          

                          



                          

                          



                          

                          

                          
Need help? Talk to Support

                          

                          

                          
            Protected by reCAPTCHA – PrivacyTerms

                          

                          

                          

                          

                          

                          

                          

                          


                          
          Sending your feedback...
        
                          

                          

                          

                          

                          

                          
      🎉 Thank you for your feedback!
    
                          

                          

                          

                          
      Something went wrong. Please try again.
    
                          

                          

                          

                          






                          Thanks for your feedback!
                          

                          
thanks-feedback-gif