Conference Streams

Create a Conference Stream

Changed on

Starts sending selected audio tracks from an active voice conference to a secure WebSocket endpoint. Use it for live conference-audio processing; use Call Streams for one call or Video Room Streams for RTMP video broadcasts.

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.

post/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Streams

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Streams
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account that created this conference.

ConferenceSidstring uuid required

Universal Unique Identifier.

The unique identifier for the conference this participant is in.

Request body application/x-www-form-urlencoded

Namestring

Unique name for the Stream, per Conference. It is used to stop a Stream by name.

Track'inbound_track' | 'outbound_track' | 'both_tracks'

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

StatusCallbackMethod'GET' | 'POST'

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

StatusCallbackstring uri

The URL to request to when stream is available.

Urlstring uri required

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.

StreamCodec'PCMU' | 'PCMA' | 'L16' | 'L16@16000h' | 'L16@24000h'

The audio codec to use for the stream.

StreamRealTimeboolean

Enable real-time streaming for the conference stream.

Parameter1.Namestring

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

Parameter1.Valuestring

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

Parameter2.Namestring

Custom parameter name to pass towards the WebSocket server.

Parameter2.Valuestring

Custom parameter value to pass towards the WebSocket server.

AuthorizationBearerTokenstring

Bearer token for authorization with the WebSocket server.

Example request

{
  "Name": "my_conference_stream",
  "Track": "both_tracks",
  "StatusCallbackMethod": "GET",
  "StatusCallback": "https://your-api-endpoint.com/stream-status",
  "Url": "wss://your-application.com/audiostream",
  "StreamCodec": "PCMU",
  "StreamRealTime": true,
  "Parameter1.Name": "FirstName",
  "Parameter1.Value": "Jane",
  "Parameter2.Name": "LastName",
  "Parameter2.Value": "Doe",
  "AuthorizationBearerToken": "your-bearer-token"
}

Response

The request has succeeded.

account_sidstring uuid required

Universal Unique Identifier.

conference_sidstring uuid required

Universal Unique Identifier.

date_updatedstring required

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

namestring nullable required

The name of the stream. May be null if not specified when creating the stream.

sidstring uuid required

Universal Unique Identifier.

status'queued' | 'in-progress' | 'stopped' required

Conference stream status.

uristring required

The URI for the stream.

Example response

{
  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
  "name": "my_conference_stream",
  "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"
}

Changes

  • 2916d5e3072eRevision changes
    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

  • 5344c0c93a4cRevision changes
    • breaking

      added 'unevaluatedProperties' constraint to the request body

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status