REST ClientCompatConferences

startStream

View as MarkdownOpen in Claude

Start a media stream on a conference, sending real-time audio to a WebSocket URL.

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

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

account_sidstringRequiredformat: "uuid"
The unique identifier for the account.
conference_sidstringRequiredformat: "uuid"
The unique identifier for the conference.
date_updatedstringRequired
The date, in RFC 2822 GMT format, this stream was updated.
namestring or nullRequired
The name of the stream. May be null if not specified when creating the stream.
sidstringRequiredformat: "uuid"
The unique identifier for the stream.
statusenumRequired
The status of the stream.
Allowed values:
uristringRequired
The URI for the stream.

Response Example

Response
1{
2  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
3  "conference_sid": "b3877c40-da60-4998-90ad-b792e98472cf",
4  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
5  "name": "my_conference_stream",
6  "sid": "b3877c40-da60-4998-90ad-b792e98472st",
7  "status": "queued",
8  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Streams/b3877c40-da60-4998-90ad-b792e98472st.json"
9}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const stream = await client.compat.conferences.startStream(
10  "CF...",
11  { Url: "wss://stream.example.com" }
12);