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

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

Property nameTypePIIDescription

conference_sidSID<CF>

Not PII

The unique SID identifier of the Conference.

Pattern: ^CF[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

friendly_namestring

PII MTL: 30 days

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

create_timestring<date-time>

Not PII

Conference creation date and time in ISO 8601 format.

start_timestring<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_timestring<date-time>

Not PII

Conference end date and time in ISO 8601 format.

duration_secondsinteger

Not PII

Conference duration in seconds.

connect_duration_secondsinteger

Not PII

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

statusenum<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_participantsinteger

Not PII

Maximum number of concurrent participants as specified by the configuration.

max_concurrent_participantsinteger

Not PII

Actual maximum number of concurrent participants in the conference.

unique_participantsinteger

Not PII

Unique conference participants based on caller ID.

end_reasonenum<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_bySID<CA>

Not PII

Call SID of the participant whose actions ended the conference.

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

mixer_regionenum<string>

Not PII

Twilio region where the conference media was mixed.

Possible values:

us1au1br1ie1jp1sg1de1

mixer_region_requestedenum<string>

Not PII

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

Possible values:

us1au1br1ie1jp1sg1de1

recording_enabledboolean

Not PII

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

detected_issuesobject

Not PII

Potential issues detected by Twilio during the conference.

tagsarray[enum<string>]

Not PII

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

Possible values:

invalid_requested_regionduplicate_identitystart_failureregion_configuration_issuesquality_warningsparticipant_behavior_issueshigh_packet_losshigh_jitterhigh_latencylow_mos

tag_infoobject

Not PII

Object. Contains details about conference tags including severity.

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

urlstring<uri>

Not PII

The URL of this resource.

linksobject<uri-map>

Not PII

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

Get a Conference Summary

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

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

Get a Conference Summary

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 fetchConference() {
_18  const conference = await client.insights.v1
_18    .conferences("CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_18    .fetch();
_18
_18  console.log(conference.conferenceSid);
_18}
_18
_18fetchConference();

Output


_45{
_45  "conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_45  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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          "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_45          "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab"
_45        ]
_45      }
_45    ]
_45  },
_45  "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_45  "links": {
_45    "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
_45  }
_45}

Get multiple Conference Summaries

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.

Query parameters

Property nameTypeRequiredPIIDescription

ConferenceSidstringOptional

Not PII

The SID of the conference.

FriendlyNamestringOptional

Not PII

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

StatusstringOptional

Not PII

Conference status.

CreatedAfterstringOptional

Not PII

Conferences created after the provided timestamp specified in ISO 8601 format

CreatedBeforestringOptional

Not PII

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

MixerRegionstringOptional

Not PII

Twilio region where the conference media was mixed.

TagsstringOptional

Not PII

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

SubaccountSID<AC>Optional

Not PII

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

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

DetectedIssuesstringOptional

Not PII

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

EndReasonstringOptional

Not PII

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

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


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

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": null,
_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": null,
_78    "key": "conferences"
_78  },
_78  "conferences": [
_78    {
_78      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "links": {
_78        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
_78      }
_78    },
_78    {
_78      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_78      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_78      "links": {
_78        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants"
_78      }
_78    }
_78  ]
_78}

Get multiple Conference Summaries for a subaccount

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 listConference() {
_19  const conferences = await client.insights.v1.conferences.list({
_19    subaccount: "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19    limit: 20,
_19  });
_19
_19  conferences.forEach((c) => console.log(c.conferenceSid));
_19}
_19
_19listConference();

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": null,
_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": null,
_78    "key": "conferences"
_78  },
_78  "conferences": [
_78    {
_78      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "links": {
_78        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
_78      }
_78    },
_78    {
_78      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_78      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_78      "links": {
_78        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants"
_78      }
_78    }
_78  ]
_78}

Get multiple Conference Summaries in ie1 with call quality detected issues

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20
_20async function listConference() {
_20  const conferences = await client.insights.v1.conferences.list({
_20    detectedIssues: "call_quality",
_20    mixerRegion: "ie1",
_20    limit: 20,
_20  });
_20
_20  conferences.forEach((c) => console.log(c.conferenceSid));
_20}
_20
_20listConference();

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": null,
_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": null,
_78    "key": "conferences"
_78  },
_78  "conferences": [
_78    {
_78      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_78      "links": {
_78        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
_78      }
_78    },
_78    {
_78      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_78      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_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/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
_78      "links": {
_78        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants"
_78      }
_78    }
_78  ]
_78}