REST Client MethodsConferences

Update

View as Markdown

Use this endpoint for the Conference method to modify the properties of a conference.

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.

Request examples

Update a conference

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('Sid')
5      .update()
6      .then(conference => console.log(conference.friendlyName))
7      .done();

Terminate a conference

End an active conference call by setting the status to completed.

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('Sid')
5      .update({status: 'completed'})
6      .then(conference => console.log(conference.friendlyName))
7      .done();