A Conference Summary provides an overview of:
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.
The following table details the properties of a single Conference Summary instance.
conference_sid
type: SID<CF>The unique SID identifier of the Conference.
^CF[0-9a-fA-F]{32}$
34
34
account_sid
type: SID<AC>The unique SID identifier of the Account.
^AC[0-9a-fA-F]{32}$
34
34
friendly_name
type: stringCustom label for the conference resource, up to 64 characters.
start_time
type: string<date-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.
connect_duration_seconds
type: integerDuration of the between conference start event and conference end event in seconds.
status
type: enum<string>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
in_progress
not_started
completed
summary_timeout
max_participants
type: integerMaximum number of concurrent participants as specified by the configuration.
max_concurrent_participants
type: integerActual maximum number of concurrent participants in the conference.
end_reason
type: enum<string>Conference end reason; e.g. last participant left, modified by API, etc.
last_participant_left
conference_ended_via_api
participant_with_end_conference_on_exit_left
last_participant_kicked
participant_with_end_conference_on_exit_kicked
ended_by
type: SID<CA>Call SID of the participant whose actions ended the conference.
^CA[0-9a-fA-F]{32}$
34
34
mixer_region
type: enum<string>Twilio region where the conference media was mixed.
us1
au1
br1
ie1
jp1
sg1
de1
mixer_region_requested
type: enum<string>Twilio region where conference mixed was specified to be mixed in configuration.
us1
au1
br1
ie1
jp1
sg1
de1
recording_enabled
type: booleanBoolean. Indicates whether recording was enabled at the conference mixer.
tags
type: array[string]Tags for detected conference conditions and participant behaviors which may be of interest.
processing_state
type: enum<string>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.
complete
in_progress
timeout
links
type: object<uri-map>Contains a dictionary of URL links to nested resources of this Conference.
GET https://insights.twilio.com/v1/Conferences/{ConferenceSid}
ConferenceSid
type: SID<CF>The unique SID identifier of the Conference.
^CF[0-9a-fA-F]{32}$
34
34
GET https://insights.twilio.com/v1/Conferences
The Conference Summary list resource allows results to be filtered by:
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.
FriendlyName
type: stringCustom label for the conference resource, up to 64 characters.
CreatedAfter
type: stringConferences created after the provided timestamp specified in ISO 8601 format
CreatedBefore
type: stringConferences created before the provided timestamp specified in ISO 8601 format.
Tags
type: stringTags applied by Twilio for common potential configuration, quality, or performance issues.
Subaccount
type: SID<AC>Account SID for the subaccount whose resources you wish to retrieve.
^AC[0-9a-fA-F]{32}$
34
34
DetectedIssues
type: stringPotential configuration, behavior, or performance issues detected during the conference.
EndReason
type: stringConference end reason; e.g. last participant left, modified by API, etc.
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0