For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
      • GETList All Conferences
      • GETRetrieve a Conference
      • POSTUpdate Conference
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIConferences

List All Conferences

|View as Markdown|Open in Claude|
GET
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:AccountSid/Conferences
GET
/api/laml/2010-04-01/Accounts/:AccountSid/Conferences
$curl https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences \
>     -u "<project_id>:<api_token>"
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": null,
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}
The ability to read all of the conferences that are associated with your Account. This will be returned as a list of conferences. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
Was this page helpful?
Previous

Retrieve a Conference

Next
Built with

The ability to read all of the conferences that are associated with your Account. This will be returned as a list of conferences.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

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

The request has succeeded.
uristring
The URI of the current page.
first_page_uristring
The URI of the first page.
next_page_uristring or null
The URI of the next page.
previous_page_uristring or null
The URI of the previous page.
pageinteger
The current page number.
page_sizeinteger
The number of items per page.
conferenceslist of objects
List of conferences.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)