For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
      • POSTCreate a Conference Stream
      • POSTUpdate Conference Stream
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIConference Streams

Update Conference Stream

|View as Markdown|Open in Claude|
POST
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:AccountSid/Conferences/:ConferenceSid/Streams/:Sid
POST
/api/laml/2010-04-01/Accounts/:AccountSid/Conferences/:ConferenceSid/Streams/:Sid
$curl -X POST https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Streams/Sid \
> -H "Content-Type: application/x-www-form-urlencoded" \
> -u "<project_id>:<api_token>" \
> -d "Status=stopped"
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}
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](/docs/platform/your-signalwire-api-space).
Was this page helpful?
Previous

List all Faxes

Next
Built with

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

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error

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)