Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Conference Summary Resource


A Conference Summary provides an overview of:

  • metadata, and
  • quality metrics

for a single conference.

Using the Conference Summary Resource, you can

(warning)

Warning

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

(information)

Info

A completed Conference Summary may take up to 30 minutes to generate following the end of the conference.


Conference Summary properties

conference-summary-properties page anchor

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

Resource properties
conference_sidtype: SID<CF>Not PII

The unique SID identifier of the Conference.


account_sidtype: SID<AC>Not PII

The unique SID identifier of the Account.


friendly_nametype: stringPII MTL: 30 days

Custom label for the conference resource, up to 64 characters.


create_timetype: string<DATE TIME>Not PII

Conference creation date and time in ISO 8601 format.


start_timetype: string<DATE TIME>Not PII

Timestamp in ISO 8601 format when the conference started. Conferences do not start until at least two participants join, at least one of whom has startConferenceOnEnter=true.


end_timetype: string<DATE TIME>Not PII

Conference end date and time in ISO 8601 format.


duration_secondstype: integerNot PII

Conference duration in seconds.


connect_duration_secondstype: integerNot PII

Duration of the between conference start event and conference end event in seconds.


statustype: enum<STRING>Not PII

Status of this Conference; in_progress, not_started, completed or summary_timeout. if Twilio don't receive last_participant_left event, summary will be timeout after 24 hours

Possible values:
in_progressnot_startedcompletedsummary_timeout

max_participantstype: integerNot PII

Maximum number of concurrent participants as specified by the configuration.


max_concurrent_participantstype: integerNot PII

Actual maximum number of concurrent participants in the conference.


unique_participantstype: integerNot PII

Unique conference participants based on caller ID.


end_reasontype: enum<STRING>Not PII

Conference end reason; e.g. last participant left, modified by API, etc.

Possible values:
last_participant_leftconference_ended_via_apiparticipant_with_end_conference_on_exit_leftlast_participant_kickedparticipant_with_end_conference_on_exit_kicked

ended_bytype: SID<CA>Not PII

Call SID of the participant whose actions ended the conference.


mixer_regiontype: enum<STRING>Not PII

Twilio region where the conference media was mixed.

Possible values:
us1au1br1ie1jp1sg1de1

mixer_region_requestedtype: enum<STRING>Not PII

Twilio region where conference mixed was specified to be mixed in configuration.

Possible values:
us1au1br1ie1jp1sg1de1

recording_enabledtype: booleanNot PII

Boolean. Indicates whether recording was enabled at the conference mixer.


detected_issuestype: objectNot PII

Potential issues detected by Twilio during the conference.


tagstype: string[]Not PII

Tags for detected conference conditions and participant behaviors which may be of interest.


tag_infotype: objectNot PII

Object. Contains details about conference tags including severity.


processing_statetype: enum<STRING>Not PII

Processing state for the Conference Summary resource. 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

urltype: string<URI>Not PII

The URL of this resource.


linkstype: object<URI MAP>Not PII

Contains a dictionary of URL links to nested resources of this Conference.


Get a Conference Summary

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

Parameters

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

The unique SID identifier of the Conference.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

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

Output

_45
{
_45
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_45
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_45
"friendly_name": "conference1",
_45
"start_time": "2021-10-08T02:58:51Z",
_45
"create_time": "2021-10-08T02:58:47Z",
_45
"end_time": "2021-10-08T03:00:02Z",
_45
"duration_seconds": 76,
_45
"connect_duration_seconds": 72,
_45
"status": "completed",
_45
"max_participants": 250,
_45
"max_concurrent_participants": 4,
_45
"unique_participants": 4,
_45
"end_reason": "last_participant_left",
_45
"ended_by": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_45
"mixer_region": "us1",
_45
"mixer_region_requested": "us1",
_45
"recording_enabled": false,
_45
"processing_state": "complete",
_45
"detected_issues": {
_45
"call_quality": 1,
_45
"region_configuration": 0,
_45
"participant_behavior": 3
_45
},
_45
"tags": [
_45
"duplicate_identity",
_45
"detected_silence",
_45
"participant_behavior_issues"
_45
],
_45
"tag_info": {
_45
"duplicate_identity": [
_45
{
_45
"participant_identity": "client:+10000000000",
_45
"participant_sids": [
_45
"CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_45
"CPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_45
]
_45
}
_45
]
_45
},
_45
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_45
"links": {
_45
"conference_participants": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants"
_45
}
_45
}


Get multiple Conference Summaries

get-multiple-conference-summaries page anchor
GET https://insights.twilio.com/v1/Conferences

The Conference Summary list resource allows results to be filtered by:

  • date,
  • friendly name,
  • region, and
  • other dimensions.

By default, the Conference Summary list resource returns a list of conferences hosted in the last 24 hours. To get multiple Conference Summaries of Conferences hosted prior to the last 24 hours, specify the CreatedAfter and/or CreatedBefore query params.

URI parameters
ConferenceSidtype: stringNot PII
Query Parameter

The SID of the conference.


FriendlyNametype: stringPII MTL: 30 days
Query Parameter

Custom label for the conference resource, up to 64 characters.


Statustype: stringNot PII
Query Parameter

Conference status.


CreatedAftertype: stringNot PII
Query Parameter

Conferences created after the provided timestamp specified in ISO 8601 format


CreatedBeforetype: stringNot PII
Query Parameter

Conferences created before the provided timestamp specified in ISO 8601 format.


MixerRegiontype: stringNot PII
Query Parameter

Twilio region where the conference media was mixed.


Tagstype: stringNot PII
Query Parameter

Tags applied by Twilio for common potential configuration, quality, or performance issues.


Subaccounttype: SID<AC>Not PII
Query Parameter

Account SID for the subaccount whose resources you wish to retrieve.


DetectedIssuestype: stringNot PII
Query Parameter

Potential configuration, behavior, or performance issues detected during the conference.


EndReasontype: stringNot PII
Query Parameter

Conference end reason; e.g. last participant left, modified by API, 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 Conference Summaries

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

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

Output

_78
{
_78
"meta": {
_78
"page": 0,
_78
"page_size": 25,
_78
"first_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"previous_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"next_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=1",
_78
"key": "conferences"
_78
},
_78
"conferences": [
_78
{
_78
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"friendly_name": "conference 1",
_78
"start_time": "2021-10-12T18:11:10Z",
_78
"create_time": "2021-10-12T18:11:09Z",
_78
"end_time": "2021-10-12T18:11:15Z",
_78
"duration_seconds": 7,
_78
"connect_duration_seconds": 5,
_78
"status": "completed",
_78
"max_participants": 250,
_78
"max_concurrent_participants": 2,
_78
"unique_participants": 2,
_78
"end_reason": "last_participant_left",
_78
"ended_by": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"mixer_region": "us1",
_78
"mixer_region_requested": null,
_78
"recording_enabled": false,
_78
"processing_state": "complete",
_78
"detected_issues": {
_78
"call_quality": 1,
_78
"region_configuration": 0,
_78
"participant_behavior": 0
_78
},
_78
"tags": null,
_78
"tag_info": null,
_78
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"links": {
_78
"conference_participants": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants"
_78
}
_78
},
_78
{
_78
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"friendly_name": "conference 2",
_78
"start_time": null,
_78
"create_time": "2021-10-12T18:09:21Z",
_78
"end_time": "2021-10-12T18:09:21Z",
_78
"duration_seconds": 1,
_78
"connect_duration_seconds": 0,
_78
"status": "completed",
_78
"max_participants": 250,
_78
"max_concurrent_participants": 2,
_78
"unique_participants": 3,
_78
"end_reason": "last_participant_left",
_78
"ended_by": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"mixer_region": "us1",
_78
"mixer_region_requested": null,
_78
"recording_enabled": false,
_78
"processing_state": "complete",
_78
"detected_issues": {
_78
"call_quality": 1,
_78
"region_configuration": 0,
_78
"participant_behavior": 0
_78
},
_78
"tags": [
_78
"detected_silence",
_78
"participant_behavior_issues"
_78
],
_78
"tag_info": null,
_78
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"links": {
_78
"conference_participants": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants"
_78
}
_78
}
_78
]
_78
}

Get multiple Conference Summaries for a subaccount

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

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

Output

_78
{
_78
"meta": {
_78
"page": 0,
_78
"page_size": 25,
_78
"first_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"previous_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"next_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=1",
_78
"key": "conferences"
_78
},
_78
"conferences": [
_78
{
_78
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"friendly_name": "conference 1",
_78
"start_time": "2021-10-12T18:11:10Z",
_78
"create_time": "2021-10-12T18:11:09Z",
_78
"end_time": "2021-10-12T18:11:15Z",
_78
"duration_seconds": 7,
_78
"connect_duration_seconds": 5,
_78
"status": "completed",
_78
"max_participants": 250,
_78
"max_concurrent_participants": 2,
_78
"unique_participants": 2,
_78
"end_reason": "last_participant_left",
_78
"ended_by": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"mixer_region": "us1",
_78
"mixer_region_requested": null,
_78
"recording_enabled": false,
_78
"processing_state": "complete",
_78
"detected_issues": {
_78
"call_quality": 1,
_78
"region_configuration": 0,
_78
"participant_behavior": 0
_78
},
_78
"tags": null,
_78
"tag_info": null,
_78
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"links": {
_78
"conference_participants": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants"
_78
}
_78
},
_78
{
_78
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"friendly_name": "conference 2",
_78
"start_time": null,
_78
"create_time": "2021-10-12T18:09:21Z",
_78
"end_time": "2021-10-12T18:09:21Z",
_78
"duration_seconds": 1,
_78
"connect_duration_seconds": 0,
_78
"status": "completed",
_78
"max_participants": 250,
_78
"max_concurrent_participants": 2,
_78
"unique_participants": 3,
_78
"end_reason": "last_participant_left",
_78
"ended_by": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"mixer_region": "us1",
_78
"mixer_region_requested": null,
_78
"recording_enabled": false,
_78
"processing_state": "complete",
_78
"detected_issues": {
_78
"call_quality": 1,
_78
"region_configuration": 0,
_78
"participant_behavior": 0
_78
},
_78
"tags": [
_78
"detected_silence",
_78
"participant_behavior_issues"
_78
],
_78
"tag_info": null,
_78
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"links": {
_78
"conference_participants": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants"
_78
}
_78
}
_78
]
_78
}

Get multiple Conference Summaries in ie1 with call quality detected issues

get-multiple-conference-summaries-in-ie1-with-call-quality-detected-issues page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

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

Output

_78
{
_78
"meta": {
_78
"page": 0,
_78
"page_size": 25,
_78
"first_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"previous_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
_78
"next_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=1",
_78
"key": "conferences"
_78
},
_78
"conferences": [
_78
{
_78
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"friendly_name": "conference 1",
_78
"start_time": "2021-10-12T18:11:10Z",
_78
"create_time": "2021-10-12T18:11:09Z",
_78
"end_time": "2021-10-12T18:11:15Z",
_78
"duration_seconds": 7,
_78
"connect_duration_seconds": 5,
_78
"status": "completed",
_78
"max_participants": 250,
_78
"max_concurrent_participants": 2,
_78
"unique_participants": 2,
_78
"end_reason": "last_participant_left",
_78
"ended_by": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"mixer_region": "us1",
_78
"mixer_region_requested": null,
_78
"recording_enabled": false,
_78
"processing_state": "complete",
_78
"detected_issues": {
_78
"call_quality": 1,
_78
"region_configuration": 0,
_78
"participant_behavior": 0
_78
},
_78
"tags": null,
_78
"tag_info": null,
_78
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"links": {
_78
"conference_participants": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants"
_78
}
_78
},
_78
{
_78
"conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"friendly_name": "conference 2",
_78
"start_time": null,
_78
"create_time": "2021-10-12T18:09:21Z",
_78
"end_time": "2021-10-12T18:09:21Z",
_78
"duration_seconds": 1,
_78
"connect_duration_seconds": 0,
_78
"status": "completed",
_78
"max_participants": 250,
_78
"max_concurrent_participants": 2,
_78
"unique_participants": 3,
_78
"end_reason": "last_participant_left",
_78
"ended_by": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"mixer_region": "us1",
_78
"mixer_region_requested": null,
_78
"recording_enabled": false,
_78
"processing_state": "complete",
_78
"detected_issues": {
_78
"call_quality": 1,
_78
"region_configuration": 0,
_78
"participant_behavior": 0
_78
},
_78
"tags": [
_78
"detected_silence",
_78
"participant_behavior_issues"
_78
],
_78
"tag_info": null,
_78
"url": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_78
"links": {
_78
"conference_participants": "https://insights.twilio.com/v1/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants"
_78
}
_78
}
_78
]
_78
}


Rate this Page: