Update Conference Stream

View as Markdown

Update an existing conference stream. Commonly used to stop/start streams or modify stream properties.

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.
SidstringRequiredformat: "uuid"
The unique identifier for the stream.

Request

This endpoint expects an object.
StatusenumRequired
The status of the stream. Only 'stopped' is allowed.
Allowed values:

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