Compatibility REST APIConferences

List All Conferences

View as Markdown
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).

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