CODEWITHSUNDEEP
twiliotwilio-api
Alan
Alan

Reputation: 10781

Using the Media Streams API to stop a stream by name

In the Twilio documentation for the REST API for Media Streams, it says the Media Stream can be stopped with a name, but I can't quite figure out how or am I reading to much into the documentation.

enter image description here

Is it possible that the documentation is only relevant when using TwiML to stop the Media Stream and not the API and thus you have have use the Media Stream SID for the API?

<Stop>
   <Stream name="my_first_stream" />
</Stop>

The example code in the docs is using the Media Steam SID only:

Stop Media Stream - Example in docs:
client.calls('CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
      .streams('MZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
      .update({status: 'stopped'})
      .then(stream => console.log(stream.name));

Upvotes: 0

Views: 564

Answers (2)

Michael Carpenter
Michael Carpenter

Reputation: 11

Works the same for interacting with Conference resource friendly names; use the resource URL; e.g.

https://api.twilio.com/2010-04-01/Accounts/{{account_sid}}/Calls/{{call_sid}}/Streams/{{stream_name}}.json

Where {{stream_name}} is the, well, stream name.

Upvotes: 1

philnash
philnash

Reputation: 73065

I am sure I have seen other APIs that allow you to specify a name or a SID when referring to the resource but I cannot find an example (so maybe I'm wrong).

This is a bit ambiguous here though. But, comments in the Node library suggest you can use a name or sid when constructing a stream:

@param {sid_like} sid - The SID of the Stream resource, or the `name`

And since those comments are derived from the API definitions, I believe that you can use the name in a REST API call too.

Upvotes: 0

Related Questions