Stop a Stream

Stop a Stream.

Permissions

The API token must include the following scopes: Voice.

Path Parameters
AccountSid uuid — REQUIRED The unique identifier for the account that is associated with this stream.
CallSid uuid — REQUIRED The unique identifier for the call that is associated with this stream.
Sid uuid — REQUIRED The unique identifier for the stream.

Request Body
Status string — REQUIRED Possible values: [in-progress, stopped] The status of the stream.

Responses

200 OK Schema — OPTIONAL account_sid uuid — OPTIONAL The unique identifier for the account that is associated with this stream. api_version string — OPTIONAL The version of the SignalWire API. call_sid string — OPTIONAL The unique identifier for the call that is associated with this stream. sid string — OPTIONAL The unique identifier for the stream. name string — OPTIONAL Unique name for the Stream, per Call. It is used to stop a Stream by name. status string — OPTIONAL Possible values: [in-progress, stopped] The status of the stream. date_updated string — OPTIONAL The date, in RFC 2822 format, this stream was updated. error_code string — OPTIONAL Further details about a failed stream. uri string — OPTIONAL The URI of the stream.