Stop a Stream using either the SID of the Stream resource

POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}.json

TODO: Resource-level docs

Stop a Stream using either the SID of the Stream resource or the name used when creating the resource

Path parameters

  • AccountSid string Required

    The SID of the Account that created this Stream resource.

  • CallSid string Required

    The SID of the Call the Stream resource is associated with.

  • Sid string Required

    The SID of the Stream resource, or the name used when creating the resource

Body

  • Status string Required

    The status. Must have the value stopped

    Value is stopped.

Responses

  • OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created this resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • call_sid string | null

      The SID of the Call the resource is associated with

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

    • date_updated string(date-time-rfc-2822) | null

      The RFC 2822 date and time in GMT that this resource was last updated

    • name string | null

      The name of this resource

    • sid string | null

      The SID of the Stream resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MZ[0-9a-fA-F]{32}$.

    • status string | null

      The status - one of stopped, in-progress

      Values are in-progress or stopped.

    • uri string(uri) | null

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

POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}.json
curl \
 -X POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}.json \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Status=stopped'
Request example
{
  "Status": "stopped"
}
Request examples
{
  "Status": "stopped"
}
Response examples (200)
{
  "account_sid": "string",
  "call_sid": "string",
  "date_updated": "string",
  "name": "string",
  "sid": "string",
  "status": "in-progress",
  "uri": "https://example.com"
}
Response examples (200)
{
  "account_sid": "string",
  "call_sid": "string",
  "date_updated": "string",
  "name": "string",
  "sid": "string",
  "status": "in-progress",
  "uri": "https://example.com"
}