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

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

Property nameTypeRequiredPIIDescriptionChild properties

participantSidSID<CP>

Optional

Not PII

SID for this participant.

Pattern: ^CP[0-9a-fA-F]{32}$Min length: 34Max length: 34

labelstring

Optional

PII MTL: 30 days

The user-specified label of this participant.

conferenceSidSID<CF>

Optional

Not PII

The unique SID identifier of the Conference.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidSID<CA>

Optional

Not PII

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

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

accountSidSID<AC>

Optional

Not PII

The unique SID identifier of the Account.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

callDirectionenum<string>

Optional

Not PII

Call direction of the participant; inbound or outbound.

Possible values:

inboundoutbound

fromstring

Optional

PII MTL: 30 days

Caller ID of the calling party.

tostring

Optional

PII MTL: 30 days

Called party.

callStatusenum<string>

Optional

Not PII

Call status of the call that generated the participant.

Possible values:

answeredcompletedbusyfailnoanswerringingcanceled

countryCodestring

Optional

Not PII

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

isModeratorboolean

Optional

Not PII

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

joinTimestring<date-time>

Optional

Not PII

ISO 8601 timestamp of participant join event.

leaveTimestring<date-time>

Optional

Not PII

ISO 8601 timestamp of participant leave event.

durationSecondsinteger

Optional

Not PII

Participant durations in seconds.

outboundQueueLengthinteger

Optional

Not PII

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

outboundTimeInQueueinteger

Optional

Not PII

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

jitterBufferSizeenum<string>

Optional

Not PII

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

Possible values:

largesmallmediumoff

isCoachboolean

Optional

Not PII

Boolean. Indicated whether participant was a coach.

coachedParticipantsarray[string]

Optional

Not PII

Call SIDs coached by this participant.

participantRegionenum<string>

Optional

Not PII

Twilio region where the participant media originates.

Possible values:

us1us2au1br1ie1jp1sg1de1in1

conferenceRegionenum<string>

Optional

Not PII

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

Possible values:

us1us2au1br1ie1jp1sg1de1in1

callTypeenum<string>

Optional

Not PII

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

Possible values:

carrierclientsip

processingStateenum<string>

Optional

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

properties

Optional

Not PII

Participant properties and metadata.

events

Optional

Not PII

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

metrics

Optional

Not PII

Object. Contains participant call quality metrics.

urlstring<uri>

Optional

Not PII

The URL of this resource.

Get a Conference Participant Summary

GET https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}

Path parameters

Property nameTypeRequiredPIIDescription

conferenceSidSID<CF>

required

Not PII

The unique SID identifier of the Conference.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

participantSidSID<CP>

required

Not PII

The unique SID identifier of the Participant.

Pattern: ^CP[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

eventsstring

Optional

Not PII

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

metricsstring

Optional

Not PII

Object. Contains participant call quality metrics.

Get a Conference Participant Summary

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchConferenceParticipant() {
11  const conferenceParticipant = await client.insights.v1
12    .conferences("CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .conferenceParticipants("CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
14    .fetch();
15
16  console.log(conferenceParticipant.participantSid);
17}
18
19fetchConferenceParticipant();

Response

1{
2  "participant_sid": "CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "label": null,
4  "conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
5  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7  "call_direction": "outbound",
8  "from": "+10000000000",
9  "to": "+1000000001",
10  "call_status": "completed",
11  "country_code": "US",
12  "is_moderator": true,
13  "join_time": "2021-10-08T02:58:59Z",
14  "leave_time": "2021-10-08T03:00:02Z",
15  "duration_seconds": 64,
16  "outbound_queue_length": 0,
17  "outbound_time_in_queue": 965,
18  "jitter_buffer_size": null,
19  "is_coach": false,
20  "coached_participants": null,
21  "participant_region": "us1",
22  "conference_region": "us1",
23  "call_type": "carrier",
24  "processing_state": "complete",
25  "properties": {
26    "start_conference_on_enter": false,
27    "end_conference_on_exit": false,
28    "play_early_media": false,
29    "enter_muted": true,
30    "beep_on_enter": false,
31    "beep_on_exit": false
32  },
33  "events": {
34    "mute": [
35      1633705131000
36    ]
37  },
38  "metrics": {
39    "inbound": {
40      "total_packets_lost": 0,
41      "total_packets_received": 49,
42      "packet_loss_percentage": 0,
43      "jitter": {
44        "avg": 0.34,
45        "max": 0.53
46      },
47      "latency": {
48        "avg": 0,
49        "max": 0
50      },
51      "mos": 4.4
52    },
53    "outbound": {
54      "total_packets_lost": 0,
55      "total_packets_received": 126,
56      "packet_loss_percentage": 0,
57      "jitter": {
58        "avg": 0.01,
59        "max": 0.01
60      },
61      "latency": {
62        "avg": 0,
63        "max": 0
64      },
65      "mos": 4.4
66    }
67  },
68  "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
69}

Get multiple Participant Summaries for a Conference

GET https://insights.twilio.com/v1/Conferences/{ConferenceSid}/Participants

Path parameters

Property nameTypeRequiredPIIDescription

conferenceSidSID<CF>

required

Not PII

The unique SID identifier of the Conference.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

participantSidstring

Optional

Not PII

The unique SID identifier of the Participant.

labelstring

Optional

PII MTL: 30 days

User-specified label for a participant.

eventsstring

Optional

Not PII

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

pageSizeinteger<int64>

Optional

Not PII

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

Minimum: 1Maximum: 1000

pageinteger

Optional

Not PII

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

Minimum: 0

pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Get multiple Participant Summaries for a Conference

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listConferenceParticipant() {
11  const conferenceParticipants = await client.insights.v1
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .conferenceParticipants.list({ limit: 20 });
14
15  conferenceParticipants.forEach((c) => console.log(c.participantSid));
16}
17
18listConferenceParticipant();

Response

1{
2  "meta": {
3    "page": 0,
4    "page_size": 25,
5    "first_page_url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0",
6    "previous_page_url": null,
7    "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0",
8    "next_page_url": null,
9    "key": "participants"
10  },
11  "participants": [
12    {
13      "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "label": null,
15      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16      "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18      "call_direction": "outbound",
19      "from": "+10000000000",
20      "to": "+10000000001",
21      "call_status": "completed",
22      "country_code": "US",
23      "is_moderator": true,
24      "join_time": "2021-10-08T02:58:51Z",
25      "leave_time": "2021-10-08T02:59:55Z",
26      "duration_seconds": 65,
27      "outbound_queue_length": 0,
28      "outbound_time_in_queue": 3361,
29      "jitter_buffer_size": null,
30      "is_coach": false,
31      "coached_participants": null,
32      "participant_region": "us1",
33      "conference_region": "us1",
34      "call_type": "carrier",
35      "processing_state": "complete",
36      "properties": {
37        "start_conference_on_enter": true,
38        "end_conference_on_exit": false,
39        "play_early_media": true,
40        "enter_muted": false,
41        "beep_on_enter": false,
42        "beep_on_exit": false
43      },
44      "metrics": {
45        "inbound": {
46          "total_packets_lost": 0,
47          "total_packets_received": 70,
48          "packet_loss_percentage": 0,
49          "jitter": {
50            "avg": 0.41,
51            "max": 0.84
52          },
53          "latency": {
54            "avg": 0,
55            "max": 0
56          },
57          "mos": 4.4
58        },
59        "outbound": {
60          "total_packets_lost": 0,
61          "total_packets_received": 126,
62          "packet_loss_percentage": 0,
63          "jitter": {
64            "avg": 0.01,
65            "max": 0.01
66          },
67          "latency": {
68            "avg": 0,
69            "max": 0
70          },
71          "mos": 4.4
72        }
73      },
74      "events": null,
75      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
76    },
77    {
78      "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
79      "label": null,
80      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
81      "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
82      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
83      "call_direction": "outbound",
84      "from": "+10000000000",
85      "to": "+10000000002",
86      "call_status": "completed",
87      "country_code": "US",
88      "is_moderator": true,
89      "join_time": "2021-10-08T02:58:52Z",
90      "leave_time": "2021-10-08T02:59:54Z",
91      "duration_seconds": 63,
92      "outbound_queue_length": 0,
93      "outbound_time_in_queue": 321,
94      "jitter_buffer_size": null,
95      "is_coach": false,
96      "coached_participants": null,
97      "participant_region": "us1",
98      "conference_region": "us1",
99      "call_type": "carrier",
100      "processing_state": "complete",
101      "properties": {
102        "start_conference_on_enter": false,
103        "end_conference_on_exit": false,
104        "early_media": false,
105        "enter_muted": true,
106        "beep_on_enter": false,
107        "beep_on_exit": false
108      },
109      "metrics": {
110        "inbound": {
111          "total_packets_lost": 0,
112          "total_packets_received": 16,
113          "packet_loss_percentage": 0,
114          "jitter": {
115            "avg": 0.26,
116            "max": 0.45
117          },
118          "latency": {
119            "avg": 0,
120            "max": 0
121          },
122          "mos": 4.4
123        },
124        "outbound": {
125          "total_packets_lost": 0,
126          "total_packets_received": 42,
127          "packet_loss_percentage": 0,
128          "jitter": {
129            "avg": 0.03,
130            "max": 0.08
131          },
132          "latency": {
133            "avg": 0,
134            "max": 0
135          },
136          "mos": 4.4,
137          "tags": [
138            "silent"
139          ]
140        }
141      },
142      "events": {
143        "mute": [
144          1633705131000
145        ]
146      },
147      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab"
148    }
149  ]
150}

Get multiple Participant Summaries for a Conference filtered by Label

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listConferenceParticipant() {
11  const conferenceParticipants = await client.insights.v1
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .conferenceParticipants.list({
14      label: "PXXXXX",
15      limit: 20,
16    });
17
18  conferenceParticipants.forEach((c) => console.log(c.participantSid));
19}
20
21listConferenceParticipant();

Response

1{
2  "meta": {
3    "page": 0,
4    "page_size": 25,
5    "first_page_url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0",
6    "previous_page_url": null,
7    "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0",
8    "next_page_url": null,
9    "key": "participants"
10  },
11  "participants": [
12    {
13      "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15      "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17      "call_direction": "outbound",
18      "from": "+10000000000",
19      "to": "+10000000001",
20      "call_status": "completed",
21      "country_code": "US",
22      "is_moderator": true,
23      "join_time": "2021-10-08T02:58:51Z",
24      "leave_time": "2021-10-08T02:59:55Z",
25      "duration_seconds": 65,
26      "label": "client",
27      "outbound_queue_length": 0,
28      "outbound_time_in_queue": 3361,
29      "jitter_buffer_size": null,
30      "is_coach": false,
31      "coached_participants": null,
32      "participant_region": "us1",
33      "conference_region": "us1",
34      "call_type": "carrier",
35      "processing_state": "complete",
36      "properties": {
37        "start_conference_on_enter": true,
38        "end_conference_on_exit": false,
39        "play_early_media": true,
40        "enter_muted": false,
41        "beep_on_enter": false,
42        "beep_on_exit": false
43      },
44      "metrics": {
45        "inbound": {
46          "total_packets_lost": 0,
47          "total_packets_received": 70,
48          "packet_loss_percentage": 0,
49          "jitter": {
50            "avg": 0.41,
51            "max": 0.84
52          },
53          "latency": {
54            "avg": 0,
55            "max": 0
56          },
57          "mos": 4.4
58        },
59        "outbound": {
60          "total_packets_lost": 0,
61          "total_packets_received": 96,
62          "packet_loss_percentage": 0,
63          "jitter": {
64            "avg": 0.01,
65            "max": 0.01
66          },
67          "latency": {
68            "avg": 0,
69            "max": 0
70          },
71          "mos": 4.4
72        }
73      },
74      "events": null,
75      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
76    }
77  ]
78}