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

Status stringrequired

Possible values: [in-progress, stopped]

The status of the stream.

Responses

200

OK

application/json

Schema

Schema

account_sid uuid

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

api_version string

The version of the SignalWire API.

call_sid string

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

sid string

The unique identifier for the stream.

name string

Unique name for the Stream, per Call. It is used to stop a Stream by name.

status string

Possible values: [in-progress, stopped]

The status of the stream.

date_updated string

The date, in RFC 2822 format, this stream was updated.

error_code string

Further details about a failed stream.

uri string

The URI of the stream.

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"
}

Loading...