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
Voice Insights Advanced Features must be active to use this API Resource.
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.
| Resource Properties in REST API format | |
|---|---|
conference_sid
|
The unique SID identifier of the Conference. |
account_sid
|
The unique SID identifier of the Account. |
friendly_name
|
Custom label for the conference resource, up to 64 characters. |
create_time
|
Conference creation date and time in ISO 8601 format. |
start_time
|
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_time
|
Conference end date and time in ISO 8601 format. |
duration_seconds
|
Conference duration in seconds. |
connect_duration_seconds
|
Duration of the between conference start event and conference end event in seconds. |
status
|
Status of this Conference; |
max_participants
|
Maximum number of concurrent participants as specified by the configuration. |
max_concurrent_participants
|
Actual maximum number of concurrent participants in the conference. |
unique_participants
|
Unique conference participants based on caller ID. |
end_reason
|
Conference end reason; e.g. last participant left, modified by API, etc. |
ended_by
|
Call SID of the participant whose actions ended the conference. |
mixer_region
|
Twilio region where the conference media was mixed. |
mixer_region_requested
|
Twilio region where conference mixed was specified to be mixed in configuration. |
recording_enabled
|
Boolean. Indicates whether recording was enabled at the conference mixer. |
detected_issues
|
Potential issues detected by Twilio during the conference. |
tags
|
Tags for detected conference conditions and participant behaviors which may be of interest. |
tag_info
|
Object. Contains details about conference tags including severity. |
processing_state
|
Processing state for the Conference Summary resource. Will be |
url
|
The URL of this resource. |
links
|
Contains a dictionary of URL links to nested resources of this Conference. |
Get a Conference Summary
https://insights.twilio.com/v1/Conferences/{ConferenceSid}
Parameters
| Parameters in REST API format | |
|---|---|
conference_sid
Path
|
The unique SID identifier of the Conference. |
Example 1
Get multiple Conference Summaries
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.
Parameters
| Parameters in REST API format | |
|---|---|
conference_sid
Optional
|
The SID of the conference. |
friendly_name
Optional
|
Custom label for the conference resource, up to 64 characters. |
status
Optional
|
Conference status. |
created_after
Optional
|
Conferences created after the provided timestamp specified in ISO 8601 format |
created_before
Optional
|
Conferences created before the provided timestamp specified in ISO 8601 format. |
mixer_region
Optional
|
Twilio region where the conference media was mixed. |
tags
Optional
|
Tags applied by Twilio for common potential configuration, quality, or performance issues. |
subaccount
Optional
|
Account SID for the subaccount whose resources you wish to retrieve. |
detected_issues
Optional
|
Potential configuration, behavior, or performance issues detected during the conference. |
end_reason
Optional
|
Conference end reason; e.g. last participant left, modified by API, etc. |
Example 1
Example 2
Example 3
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
