REST ClientCompatConferences

update

View as MarkdownOpen in Claude

Update a conference (e.g., end it, or set the announce URL). Uses POST (Twilio convention).

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
SidstringRequiredformat: "uuid"
The unique identifier for this conference.

Request

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

sidstringRequiredformat: "uuid"
The unique identifier for this conference.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
date_createdstringRequired
The date, in RFC 2822 format, this conference was created.
date_updatedstringRequired
The date, in RFC 2822 format, this conference was updated.
friendly_namestringRequired
A description, up to 64 characters, of the conference room.
statusenumRequired
The status of this conference.
Allowed values:
api_versionstringRequired
The version of the SignalWire API.
regionstringRequired
The region where this conference audio was mixed.
uristringRequired
The URI for this conference.
subresource_urisobjectRequired
The links to associated subresources.

Response Example

Response
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}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9await client.compat.conferences.update("CF...", { Status: "completed" });