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

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

Conference participants

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

Path parameters

  • AccountSid string Required

    The SID of the Account that created the Participant resources to read.

  • ConferenceSid string Required

    The SID of the conference with the participants to read.

Query parameters

  • Muted boolean

    Whether to return only participants that are muted. Can be: true or false.

  • Hold boolean

    Whether to return only participants that are on hold. Can be: true or false.

  • Coaching boolean

    Whether to return only participants who are coaching another call. Can be: true or false.

  • 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
    • end integer
    • first_page_uri string(uri)
    • next_page_uri string(uri)
    • page integer
    • page_size integer
    • participants array[object]
      Hide participants attributes Show participants attributes array[object]
      • account_sid string | null

        The SID of the Account that created the resource

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

      • call_sid string | null

        The SID of the Call the resource is associated with

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

      • call_sid_to_coach string | null

        The SID of the participant who is being coached

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

      • coaching boolean | null

        Indicates if the participant changed to coach

      • conference_sid string | null

        The SID of the conference the participant is in

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

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

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

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

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

      • Whether the conference ends when the participant leaves

      • hold boolean | null

        Whether the participant is on hold

      • label string | null

        The label of this participant

      • muted boolean | null

        Whether the participant is muted

      • Whether the conference starts when the participant joins the conference

      • status string | null

        The status of the participant's call in a session

        Values are queued, connecting, ringing, connected, complete, or failed.

      • uri string | null

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

    • start integer
    • uri string(uri)
GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json
curl \
 -X GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json \
 --user "username:password"
Response examples (200)
{
  "end": 42,
  "first_page_uri": "https://example.com",
  "next_page_uri": "https://example.com",
  "page": 42,
  "page_size": 42,
  "participants": [
    {
      "account_sid": "string",
      "call_sid": "string",
      "call_sid_to_coach": "string",
      "coaching": true,
      "conference_sid": "string",
      "date_created": "string",
      "date_updated": "string",
      "end_conference_on_exit": true,
      "hold": true,
      "label": "string",
      "muted": true,
      "start_conference_on_enter": true,
      "status": "queued",
      "uri": "string"
    }
  ],
  "previous_page_uri": "https://example.com",
  "start": 42,
  "uri": "https://example.com"
}
Response examples (200)
{
  "end": 42,
  "first_page_uri": "https://example.com",
  "next_page_uri": "https://example.com",
  "page": 42,
  "page_size": 42,
  "participants": [
    {
      "account_sid": "string",
      "call_sid": "string",
      "call_sid_to_coach": "string",
      "coaching": true,
      "conference_sid": "string",
      "date_created": "string",
      "date_updated": "string",
      "end_conference_on_exit": true,
      "hold": true,
      "label": "string",
      "muted": true,
      "start_conference_on_enter": true,
      "status": "queued",
      "uri": "string"
    }
  ],
  "previous_page_uri": "https://example.com",
  "start": 42,
  "uri": "https://example.com"
}