Compatibility REST APIConference Streams

Create a Conference Stream

View as Markdown

Create a stream for an existing conference.

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.

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) ```

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
ConferenceSidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.

Request

This endpoint expects an object.
UrlstringRequiredformat: "uri"
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.
NamestringOptional
Unique name for the Stream, per Conference. It is used to stop a Stream by name.
TrackenumOptionalDefaults to both_tracks

This attribute can be one of inbound_track, outbound_track, both_tracks. Default is both_tracks.

Allowed values:
StatusCallbackMethodenumOptionalDefaults to POST

Whether the request to StatusCallback URL is a GET or a POST. Default is POST.

Allowed values:
StatusCallbackstringOptionalformat: "uri"
The URL to request to when stream is available.
StreamCodecenumOptional
The audio codec to use for the stream.
Allowed values:
StreamRealTimebooleanOptional

Enable real-time streaming for the conference stream.

Parameter1.NamestringOptional

Custom parameter name to pass towards the WebSocket server. You can pass up to 99 custom parameters using Parameter1.Name through Parameter99.Name.

Parameter1.ValuestringOptional

Custom parameter value to pass towards the WebSocket server. You can pass up to 99 custom parameters using Parameter1.Value through Parameter99.Value.

Parameter2.NamestringOptional
Custom parameter name to pass towards the WebSocket server.
Parameter2.ValuestringOptional
Custom parameter value to pass towards the WebSocket server.
AuthorizationBearerTokenstringOptional
Bearer token for authorization with the WebSocket server.

Response

The request has succeeded.
account_sidstringformat: "uuid"
The unique identifier for the account.
conference_sidstringformat: "uuid"
The unique identifier for the conference.
date_updatedstring
The date, in RFC 2822 GMT format, this stream was updated.
namestring or null
The name of the stream. May be null if not specified when creating the stream.
sidstringformat: "uuid"
The unique identifier for the stream.
statusenum
The status of the stream.
Allowed values:
uristring
The URI for the stream.

Errors