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 nameTypeRequiredDescriptionChild properties

conferenceSidSID<CF>

Optional

Not PII

The unique SID identifier of the Conference.

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

friendlyNamestring

Optional

PII MTL: 30 days

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

createTimestring<date-time>

Optional

Not PII

Conference creation date and time in ISO 8601 format.

startTimestring<date-time>

Optional

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.

endTimestring<date-time>

Optional

Not PII

Conference end date and time in ISO 8601 format.

durationSecondsinteger

Optional

Not PII

Conference duration in seconds.

connectDurationSecondsinteger

Optional

Not PII

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

statusenum<string>

Optional

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

maxParticipantsinteger

Optional

Not PII

Maximum number of concurrent participants as specified by the configuration.

maxConcurrentParticipantsinteger

Optional

Not PII

Actual maximum number of concurrent participants in the conference.

uniqueParticipantsinteger

Optional

Not PII

Unique conference participants based on caller ID.

endReasonenum<string>

Optional

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

endedBySID<CA>

Optional

Not PII

Call SID of the participant whose actions ended the conference.

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

mixerRegionenum<string>

Optional

Not PII

Twilio region where the conference media was mixed.

Possible values:

us1us2au1br1ie1jp1sg1de1in1

mixerRegionRequestedenum<string>

Optional

Not PII

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

Possible values:

us1us2au1br1ie1jp1sg1de1in1

recordingEnabledboolean

Optional

Not PII

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

detectedIssuesobject

Optional

Not PII

Potential issues detected by Twilio during the conference.

tagsarray[enum<string>]

Optional

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

tagInfoobject

Optional

Not PII

Object. Contains details about conference tags including severity.

processingStateenum<string>

Optional

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>

Optional

Not PII

The URL of this resource.

linksobject<uri-map>

Optional

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

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 fetchConference() {
11  const conference = await client.insights.v1
12    .conferences("CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .fetch();
14
15  console.log(conference.conferenceSid);
16}
17
18fetchConference();

Response

1{
2  "conference_sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "conference1",
5  "start_time": "2021-10-08T02:58:51Z",
6  "create_time": "2021-10-08T02:58:47Z",
7  "end_time": "2021-10-08T03:00:02Z",
8  "duration_seconds": 76,
9  "connect_duration_seconds": 72,
10  "status": "completed",
11  "max_participants": 250,
12  "max_concurrent_participants": 4,
13  "unique_participants": 4,
14  "end_reason": "last_participant_left",
15  "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16  "mixer_region": "us1",
17  "mixer_region_requested": "us1",
18  "recording_enabled": false,
19  "processing_state": "complete",
20  "detected_issues": {
21    "call_quality": 1,
22    "region_configuration": 0,
23    "participant_behavior": 3
24  },
25  "tags": [
26    "duplicate_identity",
27    "detected_silence",
28    "participant_behavior_issues"
29  ],
30  "tag_info": null,
31  "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
32  "links": {
33    "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
34  }
35}

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 parameters.

Query parameters

Property nameTypeRequiredPIIDescription

conferenceSidstring

Optional

Not PII

The SID of the conference.

friendlyNamestring

Optional

PII MTL: 30 days

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

statusstring

Optional

Not PII

Conference status.

createdAfterstring

Optional

Not PII

Conferences created after the provided timestamp specified in ISO 8601 format

createdBeforestring

Optional

Not PII

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

mixerRegionstring

Optional

Not PII

Twilio region where the conference media was mixed.

tagsstring

Optional

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

detectedIssuesstring

Optional

Not PII

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

endReasonstring

Optional

Not PII

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

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 listConference() {
11  const conferences = await client.insights.v1.conferences.list({ limit: 20 });
12
13  conferences.forEach((c) => console.log(c.conferenceSid));
14}
15
16listConference();

Response

1{
2  "meta": {
3    "page": 0,
4    "page_size": 25,
5    "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",
6    "previous_page_url": null,
7    "url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
8    "next_page_url": null,
9    "key": "conferences"
10  },
11  "conferences": [
12    {
13      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15      "friendly_name": "conference 1",
16      "start_time": "2021-10-12T18:11:10Z",
17      "create_time": "2021-10-12T18:11:09Z",
18      "end_time": "2021-10-12T18:11:15Z",
19      "duration_seconds": 7,
20      "connect_duration_seconds": 5,
21      "status": "completed",
22      "max_participants": 250,
23      "max_concurrent_participants": 2,
24      "unique_participants": 2,
25      "end_reason": "last_participant_left",
26      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
27      "mixer_region": "us1",
28      "mixer_region_requested": null,
29      "recording_enabled": false,
30      "processing_state": "complete",
31      "detected_issues": {
32        "call_quality": 1,
33        "region_configuration": 0,
34        "participant_behavior": 0
35      },
36      "tags": null,
37      "tag_info": null,
38      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
39      "links": {
40        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
41      }
42    },
43    {
44      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
45      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
46      "friendly_name": "conference 2",
47      "start_time": null,
48      "create_time": "2021-10-12T18:09:21Z",
49      "end_time": "2021-10-12T18:09:21Z",
50      "duration_seconds": 1,
51      "connect_duration_seconds": 0,
52      "status": "completed",
53      "max_participants": 250,
54      "max_concurrent_participants": 2,
55      "unique_participants": 3,
56      "end_reason": "last_participant_left",
57      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
58      "mixer_region": "us1",
59      "mixer_region_requested": null,
60      "recording_enabled": false,
61      "processing_state": "complete",
62      "detected_issues": {
63        "call_quality": 1,
64        "region_configuration": 0,
65        "participant_behavior": 0
66      },
67      "tags": [
68        "detected_silence",
69        "participant_behavior_issues"
70      ],
71      "tag_info": null,
72      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
73      "links": {
74        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants"
75      }
76    }
77  ]
78}

Get multiple Conference Summaries for a subaccount

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 listConference() {
11  const conferences = await client.insights.v1.conferences.list({
12    subaccount: "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
13    limit: 20,
14  });
15
16  conferences.forEach((c) => console.log(c.conferenceSid));
17}
18
19listConference();

Response

1{
2  "meta": {
3    "page": 0,
4    "page_size": 25,
5    "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",
6    "previous_page_url": null,
7    "url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
8    "next_page_url": null,
9    "key": "conferences"
10  },
11  "conferences": [
12    {
13      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15      "friendly_name": "conference 1",
16      "start_time": "2021-10-12T18:11:10Z",
17      "create_time": "2021-10-12T18:11:09Z",
18      "end_time": "2021-10-12T18:11:15Z",
19      "duration_seconds": 7,
20      "connect_duration_seconds": 5,
21      "status": "completed",
22      "max_participants": 250,
23      "max_concurrent_participants": 2,
24      "unique_participants": 2,
25      "end_reason": "last_participant_left",
26      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
27      "mixer_region": "us1",
28      "mixer_region_requested": null,
29      "recording_enabled": false,
30      "processing_state": "complete",
31      "detected_issues": {
32        "call_quality": 1,
33        "region_configuration": 0,
34        "participant_behavior": 0
35      },
36      "tags": null,
37      "tag_info": null,
38      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
39      "links": {
40        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
41      }
42    },
43    {
44      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
45      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
46      "friendly_name": "conference 2",
47      "start_time": null,
48      "create_time": "2021-10-12T18:09:21Z",
49      "end_time": "2021-10-12T18:09:21Z",
50      "duration_seconds": 1,
51      "connect_duration_seconds": 0,
52      "status": "completed",
53      "max_participants": 250,
54      "max_concurrent_participants": 2,
55      "unique_participants": 3,
56      "end_reason": "last_participant_left",
57      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
58      "mixer_region": "us1",
59      "mixer_region_requested": null,
60      "recording_enabled": false,
61      "processing_state": "complete",
62      "detected_issues": {
63        "call_quality": 1,
64        "region_configuration": 0,
65        "participant_behavior": 0
66      },
67      "tags": [
68        "detected_silence",
69        "participant_behavior_issues"
70      ],
71      "tag_info": null,
72      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
73      "links": {
74        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants"
75      }
76    }
77  ]
78}

Get multiple Conference Summaries in ie1 with call quality detected issues

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 listConference() {
11  const conferences = await client.insights.v1.conferences.list({
12    detectedIssues: "call_quality",
13    mixerRegion: "ie1",
14    limit: 20,
15  });
16
17  conferences.forEach((c) => console.log(c.conferenceSid));
18}
19
20listConference();

Response

1{
2  "meta": {
3    "page": 0,
4    "page_size": 25,
5    "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",
6    "previous_page_url": null,
7    "url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0",
8    "next_page_url": null,
9    "key": "conferences"
10  },
11  "conferences": [
12    {
13      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15      "friendly_name": "conference 1",
16      "start_time": "2021-10-12T18:11:10Z",
17      "create_time": "2021-10-12T18:11:09Z",
18      "end_time": "2021-10-12T18:11:15Z",
19      "duration_seconds": 7,
20      "connect_duration_seconds": 5,
21      "status": "completed",
22      "max_participants": 250,
23      "max_concurrent_participants": 2,
24      "unique_participants": 2,
25      "end_reason": "last_participant_left",
26      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
27      "mixer_region": "us1",
28      "mixer_region_requested": null,
29      "recording_enabled": false,
30      "processing_state": "complete",
31      "detected_issues": {
32        "call_quality": 1,
33        "region_configuration": 0,
34        "participant_behavior": 0
35      },
36      "tags": null,
37      "tag_info": null,
38      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
39      "links": {
40        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
41      }
42    },
43    {
44      "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
45      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
46      "friendly_name": "conference 2",
47      "start_time": null,
48      "create_time": "2021-10-12T18:09:21Z",
49      "end_time": "2021-10-12T18:09:21Z",
50      "duration_seconds": 1,
51      "connect_duration_seconds": 0,
52      "status": "completed",
53      "max_participants": 250,
54      "max_concurrent_participants": 2,
55      "unique_participants": 3,
56      "end_reason": "last_participant_left",
57      "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
58      "mixer_region": "us1",
59      "mixer_region_requested": null,
60      "recording_enabled": false,
61      "processing_state": "complete",
62      "detected_issues": {
63        "call_quality": 1,
64        "region_configuration": 0,
65        "participant_behavior": 0
66      },
67      "tags": [
68        "detected_silence",
69        "participant_behavior_issues"
70      ],
71      "tag_info": null,
72      "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
73      "links": {
74        "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants"
75      }
76    }
77  ]
78}