Stop a Stream

POST 
/Accounts/:AccountSid/Calls/:CallSid/Streams/:Sid

Stop a Stream.

Permissions

The API token must include the following scopes: Voice.

Request

Path Parameters

AccountSid uuidrequired

The unique identifier for the account that is associated with this stream.

CallSid uuidrequired

The unique identifier for the call that is associated with this stream.

Sid uuidrequired

The unique identifier for the stream.

application/x-www-form-urlencoded

Body

Statusstringrequired
The status of the stream.
Possible values: [in-progress, stopped]
Example: stopped

Responses

200

OK

application/json

Schema

Schema

account_siduuid
The unique identifier for the account that is associated with this stream.
Example: 720796a0-8ee9-4350-83bd-2d07a3121f1e
api_versionstring
The version of the SignalWire API.
Example: 2010-04-01
call_sidstring
The unique identifier for the call that is associated with this stream.
Example: 43bb71ee-553f-4074-bb20-8e2747647cce
sidstring
The unique identifier for the stream.
Example: 19e436af-5688-4307-b03b-bdb2b42b8142
namestring
Unique name for the Stream, per Call. It is used to stop a Stream by name.
Example: my_first_stream
statusstring
The status of the stream.
Possible values: [in-progress, stopped]
Example: stopped
date_updatedstring
The date, in RFC 2822 format, this stream was updated.
Example: Wed, 26 Sept 2018 23:00:04 +0000
error_codestring
Further details about a failed stream.
Example: null
uristring
The URI of the stream.
Example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Calls/058a869c-d387-4bef-8e62-6b0bc0895bed/Streams/19e436af-5688-4307-b03b-bdb2b42b8142.json

Example (from schema)

{
  "account_sid": "720796a0-8ee9-4350-83bd-2d07a3121f1e",
  "api_version": "2010-04-01",
  "call_sid": "43bb71ee-553f-4074-bb20-8e2747647cce",
  "sid": "19e436af-5688-4307-b03b-bdb2b42b8142",
  "name": "my_first_stream",
  "status": "stopped",
  "date_updated": "Wed, 26 Sept 2018 23:00:04 +0000",
  "error_code": "null",
  "uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Calls/058a869c-d387-4bef-8e62-6b0bc0895bed/Streams/19e436af-5688-4307-b03b-bdb2b42b8142.json"
}