Conference Participant Summary Resource
A Conference Participant Summary contains an overview of
- metadata,
- quality metrics, and
- events
for a single participant of a conference call.
Using the Conference Participant Summary Resource, you can
Voice Insights Advanced Features must be active to use this API Resource.
Conference Participant Summary properties
The following table details the properties of a single Conference Participant Summary instance.
| Resource Properties in REST API format | |
|---|---|
participant_sid
|
SID for this participant. |
label
|
The user-specified label of this participant. |
conference_sid
|
The unique SID identifier of the Conference. |
call_sid
|
Unique SID identifier of the call that generated the Participant resource. |
account_sid
|
The unique SID identifier of the Account. |
call_direction
|
Call direction of the participant; inbound or outbound. |
from
|
Caller ID of the calling party. |
to
|
Called party. |
call_status
|
Call status of the call that generated the participant. |
country_code
|
ISO alpha-2 country code of the participant based on caller ID or called number. |
is_moderator
|
Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true. |
join_time
|
ISO 8601 timestamp of participant join event. |
leave_time
|
ISO 8601 timestamp of participant leave event. |
duration_seconds
|
Participant durations in seconds. |
outbound_queue_length
|
Add Participant API only. Estimated time in queue at call creation. |
outbound_time_in_queue
|
Add Participant API only. Actual time in queue in seconds. |
jitter_buffer_size
|
The Jitter Buffer Size of this Conference Participant. One of |
is_coach
|
Boolean. Indicated whether participant was a coach. |
coached_participants
|
Call SIDs coached by this participant. |
participant_region
|
Twilio region where the participant media originates. |
conference_region
|
The Conference Region of this Conference Participant. One of |
call_type
|
The Call Type of this Conference Participant. One of |
processing_state
|
Processing state of the Participant Summary. Will be |
properties
|
Participant properties and metadata. |
events
|
Object containing information of actions taken by participants. Contains a dictionary of URL links to nested resources of this Conference Participant. |
metrics
|
Object. Contains participant call quality metrics. |
url
|
The URL of this resource. |
Get a Conference Participant Summary
https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}
Parameters
| Parameters in REST API format | |
|---|---|
conference_sid
Path
|
The unique SID identifier of the Conference. |
participant_sid
Path
|
The unique SID identifier of the Participant. |
events
Optional
|
Conference events generated by application or participant activity; e.g. |
metrics
Optional
|
Object. Contains participant call quality metrics. |
Example 1
Get multiple Participant Summaries for a Conference
https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants
Parameters
| Parameters in REST API format | |
|---|---|
conference_sid
Path
|
The unique SID identifier of the Conference. |
participant_sid
Optional
|
The unique SID identifier of the Participant. |
label
Optional
|
User-specified label for a participant. |
events
Optional
|
Conference events generated by application or participant activity; e.g. |
Example 1
Example 2
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
