Conference Streams

Update Conference Stream

Changed on

Stops an active WebSocket audio stream for a voice conference by stream SID. This ends media delivery without ending the conference. Call audio streams and Video RTMP streams use separate operations.

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/{Sid}

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/{Sid}
  • 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.

Sidstring uuid required

Universal Unique Identifier.

The unique identifier for the stream.

Request body application/x-www-form-urlencoded

Status'stopped' required

The status of the stream. Only 'stopped' is allowed.

Example request

{
  "Status": "stopped"
}

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