Path parameters

• AccountSid string Required

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

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

• ConferenceSid string Required

  The SID of the conference with the participants to read.

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

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(int64)

  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.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • participants array[object]
    Hide participants attributes Show participants attributes object

    • account_sid string | null

      The SID of the Account that created the Participant 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 Participant resource is associated with.

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

    • label string | null

      The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant.

    • call_sid_to_coach string | null

      The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.

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

    • coaching boolean | null

      Whether the participant is coaching another call. Can be: true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined.

    • 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 date and time in GMT that the resource was created specified in RFC 2822 format.

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

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

    • end_conference_on_exit boolean | null

      Whether the conference ends when the participant leaves. Can be: true or false and the default is false. If true, the conference ends and all other participants drop out when the participant leaves.

    • muted boolean | null

      Whether the participant is muted. Can be true or false.

    • hold boolean | null

      Whether the participant is on hold. Can be true or false.

    • start_conference_on_enter boolean | null

      Whether the conference starts when the participant joins the conference, if it has not already started. Can be: true or false and the default is true. If false and the conference has not started, the participant is muted and hears background music until another participant starts the conference.

    • status string

      The status of the participant's call in a session. Can be: queued, connecting, ringing, connected, complete, or failed.

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

    • queue_time string | null

      The wait time in milliseconds before participant's call is placed. Only available in the response to a create participant request.

    • uri string | null

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

  • end integer
  • first_page_uri string(uri)
  • next_page_uri string(uri) | null
  • page integer
  • page_size integer
  • previous_page_uri string(uri) | null
  • start integer
  • uri string(uri)