Create a Stream.

Create 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.

Request Body — REQUIRED
Name string Unique name for the Stream, per Call. It is used to stop a Stream by name.
Track string Possible values: [inbound_track, outbound_track, both_tracks] This attribute can be one of inbound_track, outbound_track, both_tracks. Default is both_tracks.
StatusCallbackMethod string Possible values: [GET, POST] Whether the request to StatusCallback URL is a GET or a POST. Default is POST.
StatusCallback string The URL to request to when stream is available.
Url string Absolute or relative URL. A WebSocket connection to the url will be established and audio will start flowing towards the Websocket server. The only supported protocol is wss. For security reasons ws is NOT supported.
Parameter1.Name string Custom parameter name to pass towards the wss server
Parameter1.Value string Custom parameter value to pass towards the wss server
Parameter2.Name string Custom parameter name to pass towards the wss server
Parameter2.Value string Custom parameter value to pass towards the wss server

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.