Create a Conference Stream
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.
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
AccountSid
The unique identifier for the account that created this conference.
ConferenceSid
The unique identifier for the conference this participant is in.
Request
This endpoint expects an object.
Url
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.
Name
Unique name for the Stream, per Conference. It is used to stop a Stream by name.
Track
This attribute can be one of inbound_track, outbound_track, both_tracks. Default is both_tracks.
Allowed values:
StatusCallbackMethod
Whether the request to StatusCallback URL is a GET or a POST. Default is POST.
Allowed values:
StatusCallback
The URL to request to when stream is available.
StreamCodec
The audio codec to use for the stream.
Allowed values:
StreamRealTime
Enable real-time streaming for the conference stream.
Parameter1.Name
Custom parameter name to pass towards the WebSocket server. You can pass up to 99 custom parameters using Parameter1.Name through Parameter99.Name.
Parameter1.Value
Custom parameter value to pass towards the WebSocket server. You can pass up to 99 custom parameters using Parameter1.Value through Parameter99.Value.
Parameter2.Name
Custom parameter name to pass towards the WebSocket server.
Parameter2.Value
Custom parameter value to pass towards the WebSocket server.
AuthorizationBearerToken
Bearer token for authorization with the WebSocket server.
Response
The request has succeeded.
account_sid
The unique identifier for the account.
conference_sid
The unique identifier for the conference.
date_updated
The date, in RFC 2822 GMT format, this stream was updated.
name
The name of the stream. May be null if not specified when creating the stream.
sid
The unique identifier for the stream.
status
The status of the stream.
Allowed values:
uri
The URI for the stream.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
