REST ClientCompatConferences

list

View as MarkdownOpen in Claude

List 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 Example

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  "page": 0,
6  "page_size": 50,
7  "conferences": [
8    {
9      "sid": "b3877c40-da60-4998-90ad-b792e98472cf",
10      "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
11      "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
12      "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
13      "friendly_name": "My Conference Room",
14      "status": "init",
15      "api_version": "2010-04-01",
16      "region": "us1",
17      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json",
18      "subresource_uris": {
19        "participants": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants.json",
20        "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json"
21      }
22    }
23  ]
24}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9conferences = client.compat.conferences.list(Status="in-progress")