List Conference Participants

GET /v1/Conferences/{ConferenceSid}/Participants

TODO: Resource-level docs

List Conference Participants.

Path parameters

  • ConferenceSid string Required

    The unique SID identifier of the Conference.

Query parameters

  • ParticipantSid string

    The unique SID identifier of the Participant.

  • Label string

    User-specified label for a participant.

  • Events string

    Conference events generated by application or participant activity; e.g. hold, mute, etc.

  • 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

  • • 200

    OK

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

        Account SID.

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

      • call_direction string | null

        Call direction of the participant.

        Values are inbound or outbound.

      • call_sid string | null

        Unique SID identifier of the call.

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

      • call_status string | null

        Call status of the call that generated the participant.

        Values are answered, completed, busy, fail, noanswer, ringing, or canceled.

      • call_type string | null

        The Call Type of this Conference Participant.

        Values are carrier, client, or sip.

      • coached_participants array[string] | null

        Call SIDs coached by this participant.

      • conference_region string | null

        The Conference Region of this Conference Participant.

        Values are us1, us2, au1, br1, ie1, jp1, sg1, or de1.

      • conference_sid string | null

        Conference SID.

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

      • country_code string | null

        ISO alpha-2 country code of the participant.

      • duration_seconds integer | null

        Participant durations in seconds.

      • events

        Object containing information of actions taken by participants. Nested resource URLs.

      • from string | null

        Caller ID of the calling party.

      • is_coach boolean | null

        Boolean. Indicated whether participant was a coach.

      • is_moderator boolean | null

        Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.

      • jitter_buffer_size string | null

        The Jitter Buffer Size of this Conference Participant.

        Values are large, small, medium, or off.

      • join_time string(date-time) | null

        ISO 8601 timestamp of participant join event.

      • label string | null

        The user-specified label of this participant.

      • leave_time string(date-time) | null

        ISO 8601 timestamp of participant leave event.

      • metrics

        Object. Contains participant quality metrics.

      • outbound_queue_length integer | null

        Estimated time in queue at call creation.

      • outbound_time_in_queue integer | null

        Actual time in queue (seconds).

      • participant_region string | null

        Twilio region where the participant media originates.

        Values are us1, us2, au1, br1, ie1, jp1, sg1, or de1.

      • participant_sid string | null

        SID for this participant.

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

      • processing_state string | null

        Processing state of the Participant Summary.

        Values are complete, in_progress, or timeout.

      • properties

        Participant properties and metadata.

      • to string | null

        Called party.

      • url string(uri) | null

        The URL of this resource.
GET /v1/Conferences/{ConferenceSid}/Participants 
curl \
 -X GET https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "participants": [
    {
      "account_sid": "string",
      "call_direction": "inbound",
      "call_sid": "string",
      "call_status": "answered",
      "call_type": "carrier",
      "coached_participants": [
        "string"
      ],
      "conference_region": "us1",
      "conference_sid": "string",
      "country_code": "string",
      "duration_seconds": 42,
      "from": "string",
      "is_coach": true,
      "is_moderator": true,
      "jitter_buffer_size": "large",
      "join_time": "2023-05-04T09:42:00+00:00",
      "label": "string",
      "leave_time": "2023-05-04T09:42:00+00:00",
      "outbound_queue_length": 42,
      "outbound_time_in_queue": 42,
      "participant_region": "us1",
      "participant_sid": "string",
      "processing_state": "complete",
      "to": "string",
      "url": "https://example.com"
    }
  ]
}