Retrieve a list of conferences belonging to the account used to make the request

GET /2010-04-01/Accounts/{AccountSid}/Conferences.json

Voice call conferences

Retrieve a list of conferences belonging to the account used to make the request

Path parameters

  • AccountSid string Required

    The SID of the Account that created the Conference resource(s) to read.

Query parameters

  • DateCreated string(date)

    The date_created value, specified as YYYY-MM-DD, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD.

  • DateCreated< string(date)

    The date_created value, specified as YYYY-MM-DD, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD.

  • DateCreated> string(date)

    The date_created value, specified as YYYY-MM-DD, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD.

  • DateUpdated string(date)

    The date_updated value, specified as YYYY-MM-DD, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD.

  • DateUpdated< string(date)

    The date_updated value, specified as YYYY-MM-DD, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD.

  • DateUpdated> string(date)

    The date_updated value, specified as YYYY-MM-DD, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD.

  • The string that identifies the Conference resources to read.

  • Status string

    The status of the resources to read. Can be: init, in-progress, or completed.

    Values are init, in-progress, or completed.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • OK

    Hide response attributes Show response attributes object
    • conferences array[object]
      Hide conferences attributes Show conferences attributes array[object]
      • account_sid string | null

        The SID of the Account that created this resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • api_version string | null

        The API version used to create this conference

      • The call SID that caused the conference to end

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

      • date_created string(date-time-rfc-2822) | null

        The RFC 2822 date and time in GMT that this resource was created

      • date_updated string(date-time-rfc-2822) | null

        The RFC 2822 date and time in GMT that this resource was last updated

      • friendly_name string | null

        A string that you assigned to describe this conference room

      • The reason why a conference ended.

        Values are conference-ended-via-api, participant-with-end-conference-on-exit-left, participant-with-end-conference-on-exit-kicked, last-participant-kicked, or last-participant-left.

      • region string | null

        A string that represents the Twilio Region where the conference was mixed

      • sid string | null

        The unique string that identifies this resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CF[0-9a-fA-F]{32}$.

      • status string | null

        The status of this conference

        Values are init, in-progress, or completed.

      • subresource_uris object(uri-map) | null

        A list of related resources identified by their relative URIs

      • uri string | null

        The URI of this resource, relative to https://api.twilio.com

    • end integer
    • first_page_uri string(uri)
    • next_page_uri string(uri)
    • page integer
    • page_size integer
    • start integer
    • uri string(uri)
GET /2010-04-01/Accounts/{AccountSid}/Conferences.json
curl \
 -X GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences.json \
 --user "username:password"
Response examples (200)
{
  "conferences": [
    {
      "account_sid": "string",
      "api_version": "string",
      "call_sid_ending_conference": "string",
      "date_created": "string",
      "date_updated": "string",
      "friendly_name": "string",
      "reason_conference_ended": "conference-ended-via-api",
      "region": "string",
      "sid": "string",
      "status": "init",
      "subresource_uris": {},
      "uri": "string"
    }
  ],
  "end": 42,
  "first_page_uri": "https://example.com",
  "next_page_uri": "https://example.com",
  "page": 42,
  "page_size": 42,
  "previous_page_uri": "https://example.com",
  "start": 42,
  "uri": "https://example.com"
}
Response examples (200)
{
  "conferences": [
    {
      "account_sid": "string",
      "api_version": "string",
      "call_sid_ending_conference": "string",
      "date_created": "string",
      "date_updated": "string",
      "friendly_name": "string",
      "reason_conference_ended": "conference-ended-via-api",
      "region": "string",
      "sid": "string",
      "status": "init",
      "subresource_uris": {},
      "uri": "string"
    }
  ],
  "end": 42,
  "first_page_uri": "https://example.com",
  "next_page_uri": "https://example.com",
  "page": 42,
  "page_size": 42,
  "previous_page_uri": "https://example.com",
  "start": 42,
  "uri": "https://example.com"
}