A Conference Participant Summary contains an overview of
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.
The following table details the properties of a single Conference Participant Summary instance.
participant_sid
type: SID<CP>SID for this participant.
^CP[0-9a-fA-F]{32}$
34
34
conference_sid
type: SID<CF>The unique SID identifier of the Conference.
^CF[0-9a-fA-F]{32}$
34
34
call_sid
type: SID<CA>Unique SID identifier of the call that generated the Participant resource.
^CA[0-9a-fA-F]{32}$
34
34
account_sid
type: SID<AC>The unique SID identifier of the Account.
^AC[0-9a-fA-F]{32}$
34
34
call_direction
type: enum<string>Call direction of the participant; inbound or outbound.
inbound
outbound
call_status
type: enum<string>Call status of the call that generated the participant.
answered
completed
busy
fail
noanswer
ringing
canceled
country_code
type: stringISO alpha-2 country code of the participant based on caller ID or called number.
is_moderator
type: booleanBoolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.
outbound_queue_length
type: integerAdd Participant API only. Estimated time in queue at call creation.
outbound_time_in_queue
type: integerAdd Participant API only. Actual time in queue in seconds.
jitter_buffer_size
type: enum<string>The Jitter Buffer Size of this Conference Participant. One of large
, small
, medium
or off
.
large
small
medium
off
participant_region
type: enum<string>Twilio region where the participant media originates.
us1
us2
au1
br1
ie1
jp1
sg1
de1
conference_region
type: enum<string>The Conference Region of this Conference Participant. One of us1
, us2
, au1
, br1
, ie1
, jp1
, sg1
or de1
.
us1
us2
au1
br1
ie1
jp1
sg1
de1
call_type
type: enum<string>The Call Type of this Conference Participant. One of carrier
, client
or sip
.
carrier
client
sip
processing_state
type: enum<string>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.
complete
in_progress
timeout
events
type: objectObject containing information of actions taken by participants. Contains a dictionary of URL links to nested resources of this Conference Participant.
GET https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}
ConferenceSid
type: SID<CF>The unique SID identifier of the Conference.
^CF[0-9a-fA-F]{32}$
34
34
ParticipantSid
type: SID<CP>The unique SID identifier of the Participant.
^CP[0-9a-fA-F]{32}$
34
34
Events
type: stringConference events generated by application or participant activity; e.g. hold
, mute
, etc.
GET https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants
ConferenceSid
type: SID<CF>The unique SID identifier of the Conference.
^CF[0-9a-fA-F]{32}$
34
34
Events
type: stringConference events generated by application or participant activity; e.g. hold
, mute
, etc.
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0