REST Client MethodsConferences

List

View as Markdown

Use this endpoint for the Conference method to read all of the conferences that are associated with your SignalWire account. This will be returned as a list of conferences.

Path parameters

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

Query parameters

DateCreatedstringOptional
Shows conferences that were created on the date provided. Format: YYYY-MM-DD.
DateCreated<stringOptional
Shows conferences that were created before the date provided. Format: YYYY-MM-DD.
DateCreated>stringOptional
Shows conferences that were created after the date provided. Format: YYYY-MM-DD.
DateUpdatedstringOptional
Shows conferences that were updated on the date provided. Format: YYYY-MM-DD.
DateUpdated<stringOptional
Shows conferences that were updated before the date provided. Format: YYYY-MM-DD.
DateUpdated>stringOptional
Shows conferences that were updated after the date provided. Format: YYYY-MM-DD.
FriendlyNamestringOptional<=64 characters
A description, up to 64 characters, of the conference room.
StatusenumOptional
The status of this conference.
Allowed values:
PageintegerOptional>=0Defaults to 0
The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.
PageSizeintegerOptional1-1000Defaults to 50
The number of results to return per page. The default is 50, and the maximum is 1000.
PageTokenstringOptional
A token used to retrieve a specific page of results. Must start with PA or PB.

Response

uristringRequired
The URI of the current page.
first_page_uristringRequired
The URI of the first page.
next_page_uristring or nullRequired
The URI of the next page.
previous_page_uristring or nullRequired
The URI of the previous page.
pageintegerRequired
The current page number.
page_sizeintegerRequired
The number of items per page.
conferenceslist of objectsRequired
List of conferences.
Response
1{
2  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences?PageToken=PA1234",
3  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences",
4  "next_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences?Page=1&PageToken=PA5678",
5  "previous_page_uri": "string",
6  "page": 0,
7  "page_size": 50,
8  "conferences": [
9    {
10      "sid": "b3877c40-da60-4998-90ad-b792e98472cf",
11      "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
12      "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
13      "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
14      "friendly_name": "My Conference Room",
15      "status": "init",
16      "api_version": "2010-04-01",
17      "region": "us1",
18      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json",
19      "subresource_uris": {
20        "participants": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants.json",
21        "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json"
22      }
23    }
24  ]
25}

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences.each(conferences => console.log(conferences.sid));