Sign in
Conferences

List All Conferences

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.

get/Accounts/{AccountSid}/Conferences

Path parameters

AccountSidstring uuid required

The unique identifier for the account that created this conference.

Query parameters

DateCreatedstring

Shows conferences that were created on the date provided. Format: YYYY-MM-DD.

DateCreated<string

Shows conferences that were created before the date provided. Format: YYYY-MM-DD.

DateCreated>string

Shows conferences that were created after the date provided. Format: YYYY-MM-DD.

DateUpdatedstring

Shows conferences that were updated on the date provided. Format: YYYY-MM-DD.

DateUpdated<string

Shows conferences that were updated before the date provided. Format: YYYY-MM-DD.

DateUpdated>string

Shows conferences that were updated after the date provided. Format: YYYY-MM-DD.

FriendlyNamestring

A description, up to 64 characters, of the conference room.

Status'init' | 'in-progress' | 'completed'

Conference status.

The status of this conference.

Pageinteger

The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.

PageSizeinteger

The number of results to return per page. The default is 50, and the maximum is 1000.

PageTokenstring

A token used to retrieve a specific page of results. Must start with PA or PB.

Response

The request has succeeded.

uristring required

The URI of the current page.

first_page_uristring required

The URI of the first page.

next_page_uristring nullable required

The URI of the next page.

previous_page_uristring nullable required

The URI of the previous page.

pageinteger required

The current page number.

page_sizeinteger required

The number of items per page.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences?PageToken=PA1234",
  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences",
  "next_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences?Page=1&PageToken=PA5678",
  "page_size": 50,
  "conferences": [
    {
      "sid": "b3877c40-da60-4998-90ad-b792e98472cf",
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
      "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
      "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
      "friendly_name": "My Conference Room",
      "api_version": "2010-04-01",
      "region": "us1",
      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json",
      "subresource_uris": {
        "participants": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants.json",
        "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json"
      }
    }
  ]
}

Changes