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.
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`.

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.
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
{
  "sid": "b3877c40-da60-4998-90ad-b792e98472cf",
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
  "friendly_name": "My Conference Room",
  "status": "init",
  "api_version": "2010-04-01",
  "region": "us1",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json",
  "subresource_uris": {
    "participants": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants.json",
    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json"
  }
}

Example

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