Stream Resource Support for Twilio Regions Media Streams is now available in the Ireland (IE1) and Australia (AU1) Regions.
The Stream resource represents a live audio stream during a live call.
Creating a Stream resource creates a unidirectional Media Stream. You can stop a unidirectional Media Stream by updating the status of a Stream resource , regardless of whether the Stream was created via TwiML (with <Start><Stream>) or via REST API (with the Stream resource).
Resource properties The SID of the Stream resource.
The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream.
The status - one of stopped, in-progress
Possible values:
in-progressstoppeddate_updatedtype: string<DATE TIME RFC 2822> The URI of the resource, relative to https://api.twilio.com.
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams.jsonURI parameters Request body parameters Required
Relative or absolute url where WebSocket connection will be established.
The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream.
One of inbound_track, outbound_track, both_tracks.
Possible values:
inbound_trackoutbound_trackboth_tracksStatusCallbacktype: string<URI> Absolute URL of the status callback.
StatusCallbackMethodtype: enum<HTTP METHOD> The http method for the status_callback (one of GET, POST).
Possible values:
HEADGETPOSTPATCHPUTDELETEParameter1.Valuetype: string Parameter2.Valuetype: string Parameter3.Valuetype: string Parameter4.Valuetype: string Parameter5.Valuetype: string Parameter6.Valuetype: string Parameter7.Valuetype: string Parameter8.Valuetype: string Parameter9.Valuetype: string Parameter10.Nametype: string Parameter10.Valuetype: string Parameter11.Nametype: string Parameter11.Valuetype: string Parameter12.Nametype: string Parameter12.Valuetype: string Parameter13.Nametype: string Parameter13.Valuetype: string Parameter14.Nametype: string Parameter14.Valuetype: string Parameter15.Nametype: string Parameter15.Valuetype: string Parameter16.Nametype: string Parameter16.Valuetype: string Parameter17.Nametype: string Parameter17.Valuetype: string Parameter18.Nametype: string Parameter18.Valuetype: string Parameter19.Nametype: string Parameter19.Valuetype: string Parameter20.Nametype: string Parameter20.Valuetype: string Parameter21.Nametype: string Parameter21.Valuetype: string Parameter22.Nametype: string Parameter22.Valuetype: string Parameter23.Nametype: string Parameter23.Valuetype: string Parameter24.Nametype: string Parameter24.Valuetype: string Parameter25.Nametype: string Parameter25.Valuetype: string Parameter26.Nametype: string Parameter26.Valuetype: string Parameter27.Nametype: string Parameter27.Valuetype: string Parameter28.Nametype: string Parameter28.Valuetype: string Parameter29.Nametype: string Parameter29.Valuetype: string Parameter30.Nametype: string Parameter30.Valuetype: string Parameter31.Nametype: string Parameter31.Valuetype: string Parameter32.Nametype: string Parameter32.Valuetype: string Parameter33.Nametype: string Parameter33.Valuetype: string Parameter34.Nametype: string Parameter34.Valuetype: string Parameter35.Nametype: string Parameter35.Valuetype: string Parameter36.Nametype: string Parameter36.Valuetype: string Parameter37.Nametype: string Parameter37.Valuetype: string Parameter38.Nametype: string Parameter38.Valuetype: string Parameter39.Nametype: string Parameter39.Valuetype: string Parameter40.Nametype: string Parameter40.Valuetype: string Parameter41.Nametype: string Parameter41.Valuetype: string Parameter42.Nametype: string Parameter42.Valuetype: string Parameter43.Nametype: string Parameter43.Valuetype: string Parameter44.Nametype: string Parameter44.Valuetype: string Parameter45.Nametype: string Parameter45.Valuetype: string Parameter46.Nametype: string Parameter46.Valuetype: string Parameter47.Nametype: string Parameter47.Valuetype: string Parameter48.Nametype: string Parameter48.Valuetype: string Parameter49.Nametype: string Parameter49.Valuetype: string Parameter50.Nametype: string Parameter50.Valuetype: string Parameter51.Nametype: string Parameter51.Valuetype: string Parameter52.Nametype: string Parameter52.Valuetype: string Parameter53.Nametype: string Parameter53.Valuetype: string Parameter54.Nametype: string Parameter54.Valuetype: string Parameter55.Nametype: string Parameter55.Valuetype: string Parameter56.Nametype: string Parameter56.Valuetype: string Parameter57.Nametype: string Parameter57.Valuetype: string Parameter58.Nametype: string Parameter58.Valuetype: string Parameter59.Nametype: string Parameter59.Valuetype: string Parameter60.Nametype: string Parameter60.Valuetype: string Parameter61.Nametype: string Parameter61.Valuetype: string Parameter62.Nametype: string Parameter62.Valuetype: string Parameter63.Nametype: string Parameter63.Valuetype: string Parameter64.Nametype: string Parameter64.Valuetype: string Parameter65.Nametype: string Parameter65.Valuetype: string Parameter66.Nametype: string Parameter66.Valuetype: string Parameter67.Nametype: string Parameter67.Valuetype: string Parameter68.Nametype: string Parameter68.Valuetype: string Parameter69.Nametype: string Parameter69.Valuetype: string Parameter70.Nametype: string Parameter70.Valuetype: string Parameter71.Nametype: string Parameter71.Valuetype: string Parameter72.Nametype: string Parameter72.Valuetype: string Parameter73.Nametype: string Parameter73.Valuetype: string Parameter74.Nametype: string Parameter74.Valuetype: string Parameter75.Nametype: string Parameter75.Valuetype: string Parameter76.Nametype: string Parameter76.Valuetype: string Parameter77.Nametype: string Parameter77.Valuetype: string Parameter78.Nametype: string Parameter78.Valuetype: string Parameter79.Nametype: string Parameter79.Valuetype: string Parameter80.Nametype: string Parameter80.Valuetype: string Parameter81.Nametype: string Parameter81.Valuetype: string Parameter82.Nametype: string Parameter82.Valuetype: string Parameter83.Nametype: string Parameter83.Valuetype: string Parameter84.Nametype: string Parameter84.Valuetype: string Parameter85.Nametype: string Parameter85.Valuetype: string Parameter86.Nametype: string Parameter86.Valuetype: string Parameter87.Nametype: string Parameter87.Valuetype: string Parameter88.Nametype: string Parameter88.Valuetype: string Parameter89.Nametype: string Parameter89.Valuetype: string Parameter90.Nametype: string Parameter90.Valuetype: string Parameter91.Nametype: string Parameter91.Valuetype: string Parameter92.Nametype: string Parameter92.Valuetype: string Parameter93.Nametype: string Parameter93.Valuetype: string Parameter94.Nametype: string Parameter94.Valuetype: string Parameter95.Nametype: string Parameter95.Valuetype: string Parameter96.Nametype: string Parameter96.Valuetype: string Parameter97.Nametype: string Parameter97.Valuetype: string Parameter98.Nametype: string Parameter98.Valuetype: string Parameter99.Nametype: string Parameter99.Valuetype: string
Create a Stream resource during a live call in order to start a new unidirectional Media Stream. Twilio sends the call's forked audio stream to the url specified in this request.
A sample request is shown below.
_14 // Download the helper library from https://www.twilio.com/docs/node/install
_14 // Find your Account SID and Auth Token at twilio.com/console
_14 // and set the environment variables. See http://twil.io/secure
_14 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14 const authToken = process.env.TWILIO_AUTH_TOKEN;
_14 const client = require('twilio')(accountSid, authToken);
_14 client.calls('CAXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_14 name: 'My Media Stream',
_14 url: 'wss://example.com/a-websocket-server'
_14 .then(stream => console.log(stream.sid));
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "sid": "MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "name": "My Media Stream",
_10 "status": "in-progress",
_10 "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Calls/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Streams/MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
You can also create a unidirectional Media Stream with custom parameters.
Twilio sends these custom parameters to your WebSocket server in the start WebSocket message. Learn more on the WebSocket Messages page .
Use the parameter[x].name and parameter[x].value parameters to specify key-value pairs. For example, parameter1.name is the key and parameter1.value is the value of a key-value pair. You can provide up to 99 key-value pairs (parameter99.name and parameter99.value).
An example request is shown below.
_18 // Download the helper library from https://www.twilio.com/docs/node/install
_18 // Find your Account SID and Auth Token at twilio.com/console
_18 // and set the environment variables. See http://twil.io/secure
_18 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18 const authToken = process.env.TWILIO_AUTH_TOKEN;
_18 const client = require('twilio')(accountSid, authToken);
_18 client.calls('CAXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_18 name: 'My Media Stream',
_18 'parameter1.name': 'agent_name',
_18 'parameter1.value': 'Mary',
_18 'parameter2.name': 'Department',
_18 'parameter2.value': 'sales',
_18 url: 'wss://example.com/a-websocket-server'
_18 .then(stream => console.log(stream.sid));
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "sid": "MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "name": "My Media Stream",
_10 "status": "in-progress",
_10 "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Calls/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Streams/MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}.jsonTo stop a live unidirectional Media Stream, update the Stream resource's status to stopped.
URI parameters Path Parameter
The SID of the Stream resource, or the name used when creating the resource
Request body parameters Required
The status. Must have the value stopped
An example request is shown below.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.calls('CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .streams('MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .update({status: 'stopped'})
_11 .then(stream => console.log(stream.name));
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "sid": "MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Calls/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Streams/MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
You can also use the Stream name (if provided when creating the Stream) to stop the Stream. The example below shows how to stop a Stream with a name of myStream.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.calls('CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .update({status: 'stopped'})
_11 .then(stream => console.log(stream.name));
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "sid": "MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Calls/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Streams/MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"