Stop a Stream | SignalWire

Stops an active WebSocket audio stream on a call by stream SID. This ends media delivery without ending the call. Conference audio streams and Video RTMP streams have separate operations.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Stops an active WebSocket audio stream on a call by stream SID. This ends media delivery without ending the call. Conference audio streams and Video RTMP streams have separate operations. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"

The Project ID that uniquely identifies the Account.

CallSidstringRequiredformat: "uuid"

The unique identifier for the call.

SidstringRequiredformat: "uuid"

The unique identifier for the call.

Request

This endpoint expects an object.

StatusenumRequired

The status of the stream. Only 'stopped' is allowed.

Response

The request has succeeded.

sidstringformat: "uuid"

The unique identifier for the stream.

account_sidstringformat: "uuid"

The unique identifier for the account.

call_sidstringformat: "uuid"

The unique identifier for the call.

namestring

The name of the stream.

statusenum

The status of the stream.

date_updatedstring

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

uristring

The URI for the stream.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

503

Service Unavailable Error