Skip to contentSkip to navigationSkip to topbar
Rate this Page:

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

(warning)

Warning

Voice Insights Advanced Features must be active to use this API Resource.


Conference Participant Summary properties

conference-participant-summary-properties page anchor

The following table details the properties of a single Conference Participant Summary instance.

Resource properties
participant_sidtype: SID<CP>Not PII

SID for this participant.


labeltype: stringPII MTL: 30 days

The user-specified label of this participant.


conference_sidtype: SID<CF>Not PII

The unique SID identifier of the Conference.


call_sidtype: SID<CA>Not PII

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


account_sidtype: SID<AC>Not PII

The unique SID identifier of the Account.


call_directiontype: enum<STRING>Not PII

Call direction of the participant; inbound or outbound.

Possible values:
inboundoutbound

fromtype: stringPII MTL: 30 days

Caller ID of the calling party.


totype: stringPII MTL: 30 days

Called party.


call_statustype: enum<STRING>Not PII

Call status of the call that generated the participant.

Possible values:
answeredcompletedbusyfailnoanswerringingcanceled

country_codetype: stringNot PII

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


is_moderatortype: booleanNot PII

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


join_timetype: string<DATE TIME>Not PII

ISO 8601 timestamp of participant join event.


leave_timetype: string<DATE TIME>Not PII

ISO 8601 timestamp of participant leave event.


duration_secondstype: integerNot PII

Participant durations in seconds.


outbound_queue_lengthtype: integerNot PII

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


outbound_time_in_queuetype: integerNot PII

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


jitter_buffer_sizetype: enum<STRING>Not PII

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

Possible values:
largesmallmediumoff

is_coachtype: booleanNot PII

Boolean. Indicated whether participant was a coach.


coached_participantstype: string[]Not PII

Call SIDs coached by this participant.


participant_regiontype: enum<STRING>Not PII

Twilio region where the participant media originates.

Possible values:
us1us2au1br1ie1jp1sg1de1

conference_regiontype: enum<STRING>Not PII

The Conference Region of this Conference Participant. One of us1, us2, au1, br1, ie1, jp1, sg1 or de1.

Possible values:
us1us2au1br1ie1jp1sg1de1

call_typetype: enum<STRING>Not PII

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

Possible values:
carrierclientsip

processing_statetype: enum<STRING>Not PII

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.

Possible values:
completein_progresstimeout

propertiestype: objectNot PII

Participant properties and metadata.


eventstype: objectNot PII

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


metricstype: objectNot PII

Object. Contains participant call quality metrics.


urltype: string<URI>Not PII

The URL of this resource.


Get a Conference Participant Summary

get-a-conference-participant-summary page anchor
GET https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}

Parameters

fetch-parameters page anchor
URI parameters
ConferenceSidtype: SID<CF>Not PII
Path Parameter

The unique SID identifier of the Conference.


ParticipantSidtype: SID<CP>Not PII
Path Parameter

The unique SID identifier of the Participant.


Eventstype: stringNot PII
Query Parameter

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


Metricstype: stringNot PII
Query Parameter

Object. Contains participant call quality metrics.

Get a Conference Participant Summary

get-a-conference-participant-summary-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.insights.v1.conferences('CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.conferenceParticipants('CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.fetch()
_11
.then(conference_participant => console.log(conference_participant.to));

Output

_69
{
_69
"participant_sid": "CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_69
"label": null,
_69
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_69
"call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_69
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_69
"call_direction": "outbound",
_69
"from": "+10000000000",
_69
"to": "+1000000001",
_69
"call_status": "completed",
_69
"country_code": "US",
_69
"is_moderator": true,
_69
"join_time": "2021-10-08T02:58:59Z",
_69
"leave_time": "2021-10-08T03:00:02Z",
_69
"duration_seconds": 64,
_69
"outbound_queue_length": 0,
_69
"outbound_time_in_queue": 965,
_69
"jitter_buffer_size": null,
_69
"is_coach": false,
_69
"coached_participants": null,
_69
"participant_region": "us1",
_69
"conference_region": "us1",
_69
"call_type": "carrier",
_69
"processing_state": "complete",
_69
"properties": {
_69
"start_conference_on_enter": false,
_69
"end_conference_on_exit": false,
_69
"play_early_media": false,
_69
"enter_muted": true,
_69
"beep_on_enter": false,
_69
"beep_on_exit": false
_69
},
_69
"events": {
_69
"mute": [
_69
1633705131000
_69
]
_69
},
_69
"metrics": {
_69
"inbound": {
_69
"total_packets_lost": 0,
_69
"total_packets_received": 49,
_69
"packet_loss_percentage": 0.0,
_69
"jitter": {
_69
"avg": 0.34,
_69
"max": 0.53
_69
},
_69
"latency": {
_69
"avg": 0.0,
_69
"max": 0.0
_69
},
_69
"mos": 4.4
_69
},
_69
"outbound": {
_69
"total_packets_lost": 0,
_69
"total_packets_received": 126,
_69
"packet_loss_percentage": 0,
_69
"jitter": {
_69
"avg": 0.01,
_69
"max": 0.01
_69
},
_69
"latency": {
_69
"avg": 0,
_69
"max": 0
_69
},
_69
"mos": 4.4
_69
}
_69
},
_69
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_69
}


Get multiple Participant Summaries for a Conference

get-multiple-participant-summaries-for-a-conference page anchor
GET https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants

URI parameters
ConferenceSidtype: SID<CF>Not PII
Path Parameter

The unique SID identifier of the Conference.


ParticipantSidtype: stringNot PII
Query Parameter

The unique SID identifier of the Participant.


Labeltype: stringPII MTL: 30 days
Query Parameter

User-specified label for a participant.


Eventstype: stringNot PII
Query Parameter

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


PageSizetype: integerNot PII
Query Parameter

How many resources to return in each list page. The default is 50, and the maximum is 1000.


Pagetype: integerNot PII
Query Parameter

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


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

Get multiple Participant Summaries for a Conference

get-multiple-participant-summaries-for-a-conference-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.insights.v1.conferences('CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.conferenceParticipants
_11
.list({limit: 20})
_11
.then(conferenceParticipants => conferenceParticipants.forEach(c => console.log(c.to)));

Output

_150
{
_150
"meta": {
_150
"page": 0,
_150
"page_size": 25,
_150
"first_page_url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?PageSize=25&Page=0",
_150
"previous_page_url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?PageSize=25&Page=0",
_150
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?PageSize=25&Page=0",
_150
"next_page_url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?PageSize=25&Page=1",
_150
"key": "participants"
_150
},
_150
"participants": [
_150
{
_150
"participant_sid": "CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_150
"label": null,
_150
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_150
"call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_150
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_150
"call_direction": "outbound",
_150
"from": "+10000000000",
_150
"to": "+10000000001",
_150
"call_status": "completed",
_150
"country_code": "US",
_150
"is_moderator": true,
_150
"join_time": "2021-10-08T02:58:51Z",
_150
"leave_time": "2021-10-08T02:59:55Z",
_150
"duration_seconds": 65,
_150
"outbound_queue_length": 0,
_150
"outbound_time_in_queue": 3361,
_150
"jitter_buffer_size": null,
_150
"is_coach": false,
_150
"coached_participants": null,
_150
"participant_region": "us1",
_150
"conference_region": "us1",
_150
"call_type": "carrier",
_150
"processing_state": "complete",
_150
"properties": {
_150
"start_conference_on_enter": true,
_150
"end_conference_on_exit": false,
_150
"play_early_media": true,
_150
"enter_muted": false,
_150
"beep_on_enter": false,
_150
"beep_on_exit": false
_150
},
_150
"metrics": {
_150
"inbound": {
_150
"total_packets_lost": 0,
_150
"total_packets_received": 70,
_150
"packet_loss_percentage": 0.0,
_150
"jitter": {
_150
"avg": 0.41,
_150
"max": 0.84
_150
},
_150
"latency": {
_150
"avg": 0.0,
_150
"max": 0.0
_150
},
_150
"mos": 4.4
_150
},
_150
"outbound": {
_150
"total_packets_lost": 0,
_150
"total_packets_received": 126,
_150
"packet_loss_percentage": 0,
_150
"jitter": {
_150
"avg": 0.01,
_150
"max": 0.01
_150
},
_150
"latency": {
_150
"avg": 0,
_150
"max": 0
_150
},
_150
"mos": 4.4
_150
}
_150
},
_150
"events": null,
_150
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_150
},
_150
{
_150
"participant_sid": "CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_150
"label": null,
_150
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_150
"call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_150
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_150
"call_direction": "outbound",
_150
"from": "+10000000000",
_150
"to": "+10000000002",
_150
"call_status": "completed",
_150
"country_code": "US",
_150
"is_moderator": true,
_150
"join_time": "2021-10-08T02:58:52Z",
_150
"leave_time": "2021-10-08T02:59:54Z",
_150
"duration_seconds": 63,
_150
"outbound_queue_length": 0,
_150
"outbound_time_in_queue": 321,
_150
"jitter_buffer_size": null,
_150
"is_coach": false,
_150
"coached_participants": null,
_150
"participant_region": "us1",
_150
"conference_region": "us1",
_150
"call_type": "carrier",
_150
"processing_state": "complete",
_150
"properties": {
_150
"start_conference_on_enter": false,
_150
"end_conference_on_exit": false,
_150
"early_media": false,
_150
"enter_muted": true,
_150
"beep_on_enter": false,
_150
"beep_on_exit": false
_150
},
_150
"metrics": {
_150
"inbound": {
_150
"total_packets_lost": 0,
_150
"total_packets_received": 16,
_150
"packet_loss_percentage": 0,
_150
"jitter": {
_150
"avg": 0.26,
_150
"max": 0.45
_150
},
_150
"latency": {
_150
"avg": 0,
_150
"max": 0
_150
},
_150
"mos": 4.4
_150
},
_150
"outbound": {
_150
"total_packets_lost": 0,
_150
"total_packets_received": 42,
_150
"packet_loss_percentage": 0,
_150
"jitter": {
_150
"avg": 0.03,
_150
"max": 0.08
_150
},
_150
"latency": {
_150
"avg": 0,
_150
"max": 0
_150
},
_150
"mos": 4.4,
_150
"tags": [
_150
"silent"
_150
]
_150
}
_150
},
_150
"events": {
_150
"mute": [
_150
1633705131000
_150
]
_150
},
_150
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_150
}
_150
]
_150
}

Get multiple Participant Summaries for a Conference filtered by Label

get-multiple-participant-summaries-for-a-conference-filtered-by-label page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.insights.v1.conferences('CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.conferenceParticipants
_11
.list({label: 'PXXXXX', limit: 20})
_11
.then(conferenceParticipants => conferenceParticipants.forEach(c => console.log(c.to)));

Output

_78
{
_78
"meta": {
_78
"page": 0,
_78
"page_size": 25,
_78
"first_page_url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Label=client&PageSize=25&Page=0",
_78
"previous_page_url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Label=client&PageSize=25&Page=0",
_78
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Label=client&PageSize=25&Page=0",
_78
"next_page_url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?Label=client&PageSize=25&Page=1",
_78
"key": "participants"
_78
},
_78
"participants": [
_78
{
_78
"participant_sid": "CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"call_direction": "outbound",
_78
"from": "+10000000000",
_78
"to": "+10000000001",
_78
"call_status": "completed",
_78
"country_code": "US",
_78
"is_moderator": true,
_78
"join_time": "2021-10-08T02:58:51Z",
_78
"leave_time": "2021-10-08T02:59:55Z",
_78
"duration_seconds": 65,
_78
"label": "client",
_78
"outbound_queue_length": 0,
_78
"outbound_time_in_queue": 3361,
_78
"jitter_buffer_size": null,
_78
"is_coach": false,
_78
"coached_participants": null,
_78
"participant_region": "us1",
_78
"conference_region": "us1",
_78
"call_type": "carrier",
_78
"processing_state": "complete",
_78
"properties": {
_78
"start_conference_on_enter": true,
_78
"end_conference_on_exit": false,
_78
"play_early_media": true,
_78
"enter_muted": false,
_78
"beep_on_enter": false,
_78
"beep_on_exit": false
_78
},
_78
"metrics": {
_78
"inbound": {
_78
"total_packets_lost": 0,
_78
"total_packets_received": 70,
_78
"packet_loss_percentage": 0.0,
_78
"jitter": {
_78
"avg": 0.41,
_78
"max": 0.84
_78
},
_78
"latency": {
_78
"avg": 0.0,
_78
"max": 0.0
_78
},
_78
"mos": 4.4
_78
},
_78
"outbound": {
_78
"total_packets_lost": 0,
_78
"total_packets_received": 96,
_78
"packet_loss_percentage": 0,
_78
"jitter": {
_78
"avg": 0.01,
_78
"max": 0.01
_78
},
_78
"latency": {
_78
"avg": 0,
_78
"max": 0
_78
},
_78
"mos": 4.4
_78
}
_78
},
_78
"events": null,
_78
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_78
}
_78
]
_78
}


Rate this Page: