Get a specific Conference Participant Summary for a Conference.

GET /v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}

Get a specific Conference Participant Summary for a Conference.

Path parameters

  • ConferenceSid string Required

    The unique SID identifier of the Conference.

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

  • ParticipantSid string Required

    The unique SID identifier of the Participant.

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

Query parameters

  • Events string

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

  • Metrics string

    Object. Contains participant call quality metrics.

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
    • 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}$.

    • label string | null

      The user-specified label of this participant.

    • conference_sid string | null

      The unique SID identifier of the Conference.

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

    • call_sid string | null

      Unique SID identifier of the call that generated the Participant resource.

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

    • account_sid string | null

      The unique SID identifier of the Account.

      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; inbound or outbound.

      Values are inbound or outbound.

    • from string | null

      Caller ID of the calling party.

    • to string | null

      Called party.

    • call_status string | null

      Call status of the call that generated the participant.

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

    • country_code string | null

      ISO alpha-2 country code of the participant based on caller ID or called number.

    • is_moderator boolean | null

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

    • join_time string(date-time) | null

      ISO 8601 timestamp of participant join event.

    • leave_time string(date-time) | null

      ISO 8601 timestamp of participant leave event.

    • duration_seconds integer | null

      Participant durations in seconds.

    • outbound_queue_length integer | null

      Add Participant API only. Estimated time in queue at call creation.

    • outbound_time_in_queue integer | null

      Add Participant API only. Actual time in queue in seconds.

    • jitter_buffer_size string | null

      The Jitter Buffer Size of this Conference Participant. One of large, small, medium or off.

      Values are large, small, medium, or off.

    • is_coach boolean | null

      Boolean. Indicated whether participant was a coach.

    • coached_participants array[string] | null

      Call SIDs coached by this participant.

    • participant_region string | null

      Twilio region where the participant media originates.

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

    • conference_region string | null

      Twilio region where the participant media originates.

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

    • call_type string | null

      The Call Type of this Conference Participant. One of carrier, client or sip.

      Values are carrier, client, or sip.

    • processing_state string | null

      Processing state of the Participant Summary. Will be in_progress while data is being aggregated, timeout if Twilio couldn't process the summary in 24hrs, and complete once aggregations and analysis has ended.

      Values are complete, in_progress, or timeout.

    • properties object | null

      Participant properties and metadata.

    • events object | null

      Object containing information of actions taken by participants. Contains a dictionary of URL links to nested resources of this Conference Participant.

    • metrics object | null

      Object. Contains participant call quality metrics.

    • url string(uri) | null

      The URL of this resource.

GET /v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}
curl \
 --request GET 'https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}' \
 --user "username:password"
Response examples (200)
{
  "to": "+1000000001",
  "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "from": "+10000000000",
  "label": null,
  "events": {
    "mute": [
      1633705131000
    ]
  },
  "metrics": {
    "inbound": {
      "mos": 4.4,
      "jitter": {
        "avg": 0.34,
        "max": 0.53
      },
      "latency": {
        "avg": 0,
        "max": 0
      },
      "total_packets_lost": 0,
      "packet_loss_percentage": 0,
      "total_packets_received": 49
    },
    "outbound": {
      "mos": 4.4,
      "jitter": {
        "avg": 0.01,
        "max": 0.01
      },
      "latency": {
        "avg": 0,
        "max": 0
      },
      "total_packets_lost": 0,
      "packet_loss_percentage": 0,
      "total_packets_received": 126
    }
  },
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "is_coach": false,
  "call_type": "carrier",
  "join_time": "2021-10-08T02:58:59Z",
  "leave_time": "2021-10-08T03:00:02Z",
  "properties": {
    "enter_muted": true,
    "beep_on_exit": false,
    "beep_on_enter": false,
    "play_early_media": false,
    "end_conference_on_exit": false,
    "start_conference_on_enter": false
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_status": "completed",
  "country_code": "US",
  "is_moderator": true,
  "call_direction": "outbound",
  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "duration_seconds": 64,
  "processing_state": "complete",
  "conference_region": "us1",
  "jitter_buffer_size": null,
  "participant_region": "us1",
  "coached_participants": null,
  "outbound_queue_length": 0,
  "outbound_time_in_queue": 965
}