On 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

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

Property nameTypePIIDescription

participant_sidSID<CP>

Not PII

SID for this participant.

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

labelstring

PII MTL: 30 days

The user-specified label of this participant.

conference_sidSID<CF>

Not PII

The unique SID identifier of the Conference.

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

call_sidSID<CA>

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

account_sidSID<AC>

Not PII

The unique SID identifier of the Account.

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

call_directionenum<string>

Not PII

Call direction of the participant; inbound or outbound.

Possible values:

inboundoutbound

fromstring

PII MTL: 30 days

Caller ID of the calling party.

tostring

PII MTL: 30 days

Called party.

call_statusenum<string>

Not PII

Call status of the call that generated the participant.

Possible values:

answeredcompletedbusyfailnoanswerringingcanceled

country_codestring

Not PII

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

is_moderatorboolean

Not PII

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

join_timestring<date-time>

Not PII

ISO 8601 timestamp of participant join event.

leave_timestring<date-time>

Not PII

ISO 8601 timestamp of participant leave event.

duration_secondsinteger

Not PII

Participant durations in seconds.

outbound_queue_lengthinteger

Not PII

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

outbound_time_in_queueinteger

Not PII

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

jitter_buffer_sizeenum<string>

Not PII

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

Possible values:

largesmallmediumoff

is_coachboolean

Not PII

Boolean. Indicated whether participant was a coach.

coached_participantsarray[string]

Not PII

Call SIDs coached by this participant.

participant_regionenum<string>

Not PII

Twilio region where the participant media originates.

Possible values:

us1us2au1br1ie1jp1sg1de1

conference_regionenum<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_typeenum<string>

Not PII

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

Possible values:

carrierclientsip

processing_stateenum<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

propertiesobject

Not PII

Participant properties and metadata.

eventsobject

Not PII

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

metricsobject

Not PII

Object. Contains participant call quality metrics.

urlstring<uri>

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

EventsstringOptional

Not PII

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

MetricsstringOptional

Not PII

Object. Contains participant call quality metrics.

Get a Conference Participant Summary

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19
_19async function fetchConferenceParticipant() {
_19  const conferenceParticipant = await client.insights.v1
_19    .conferences("CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19    .conferenceParticipants("CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19    .fetch();
_19
_19  console.log(conferenceParticipant.participantSid);
_19}
_19
_19fetchConferenceParticipant();

Output


_69{
_69  "participant_sid": "CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_69  "label": null,
_69  "conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_69  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_69  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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,
_69      "jitter": {
_69        "avg": 0.34,
_69        "max": 0.53
_69      },
_69      "latency": {
_69        "avg": 0,
_69        "max": 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/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

ParticipantSidstringOptional

Not PII

The unique SID identifier of the Participant.

LabelstringOptional

Not PII

User-specified label for a participant.

EventsstringOptional

Not PII

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

PageSizeintegerOptional

Not PII

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

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

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

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

Get multiple Participant Summaries for a Conference

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function listConferenceParticipant() {
_18  const conferenceParticipants = await client.insights.v1
_18    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .conferenceParticipants.list({ limit: 20 });
_18
_18  conferenceParticipants.forEach((c) => console.log(c.participantSid));
_18}
_18
_18listConferenceParticipant();

Output


_150{
_150  "meta": {
_150    "page": 0,
_150    "page_size": 25,
_150    "first_page_url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0",
_150    "previous_page_url": null,
_150    "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0",
_150    "next_page_url": null,
_150    "key": "participants"
_150  },
_150  "participants": [
_150    {
_150      "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_150      "label": null,
_150      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_150      "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_150      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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,
_150          "jitter": {
_150            "avg": 0.41,
_150            "max": 0.84
_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": 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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_150    },
_150    {
_150      "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_150      "label": null,
_150      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_150      "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_150      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab"
_150    }
_150  ]
_150}

Get multiple Participant Summaries for a Conference filtered by Label

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_21// Download the helper library from https://www.twilio.com/docs/node/install
_21const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_21
_21// Find your Account SID and Auth Token at twilio.com/console
_21// and set the environment variables. See http://twil.io/secure
_21const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21const authToken = process.env.TWILIO_AUTH_TOKEN;
_21const client = twilio(accountSid, authToken);
_21
_21async function listConferenceParticipant() {
_21  const conferenceParticipants = await client.insights.v1
_21    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_21    .conferenceParticipants.list({
_21      label: "PXXXXX",
_21      limit: 20,
_21    });
_21
_21  conferenceParticipants.forEach((c) => console.log(c.participantSid));
_21}
_21
_21listConferenceParticipant();

Output


_78{
_78  "meta": {
_78    "page": 0,
_78    "page_size": 25,
_78    "first_page_url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0",
_78    "previous_page_url": null,
_78    "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0",
_78    "next_page_url": null,
_78    "key": "participants"
_78  },
_78  "participants": [
_78    {
_78      "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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,
_78          "jitter": {
_78            "avg": 0.41,
_78            "max": 0.84
_78          },
_78          "latency": {
_78            "avg": 0,
_78            "max": 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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_78    }
_78  ]
_78}