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
      • GETList All Conferences
      • GETRetrieve a Conference
      • POSTUpdate Conference
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIConferences

Update Conference

|View as Markdown|Open in Claude|
POST
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:AccountSid/Conferences/:Sid
POST
/api/laml/2010-04-01/Accounts/:AccountSid/Conferences/:Sid
$curl -X POST https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/Sid \
>     -H "Content-Type: application/x-www-form-urlencoded" \
>     -u "<project_id>:<api_token>"
1{
2  "sid": "b3877c40-da60-4998-90ad-b792e98472cf",
3  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
4  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
5  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
6  "friendly_name": "My Conference Room",
7  "status": "init",
8  "api_version": "2010-04-01",
9  "region": "us1",
10  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json",
11  "subresource_uris": {
12    "participants": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants.json",
13    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json"
14  }
15}

Allows you to modify the properties of a conference.

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.

Was this page helpful?
Previous

List all active Participants

Next
Built with

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

Request

This endpoint expects an object.
StatusenumOptional
The status of this conference. Only 'completed' is allowed to end the conference.
Allowed values:
AnnounceUrlstringOptionalformat: "uri"
The URL to send conference announcements to.
AnnounceMethodenumOptionalDefaults to POST

Whether the request to AnnounceUrl is a GET or a POST. Default is POST.

Allowed values:

Response

The request has succeeded.
sidstringformat: "uuid"
The unique identifier for this conference.
account_sidstringformat: "uuid"
The unique identifier for the account that created this conference.
date_createdstring
The date, in RFC 2822 format, this conference was created.
date_updatedstring
The date, in RFC 2822 format, this conference was updated.
friendly_namestring
A description, up to 64 characters, of the conference room.
statusenum
The status of this conference.
Allowed values:
api_versionstring
The version of the SignalWire API.
regionstring
The region where this conference audio was mixed.
uristring
The URI for this conference.
subresource_urisobject
The links to associated subresources.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable 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)