REST Client MethodsConferences

Retrieve

View as Markdown

Use this endpoint for the Conference method to retrieve a single conference.

Path parameters

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

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

Request examples

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