Call Summary Resource

A Call Summary provides an overview of

metadata, and
quality metrics

for a single call.

Using the Call Summary Resource, you can get a single summary for a specific Call.

To get a list of Call Summaries for multiple calls use the Call Summaries Resource.

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

A completed Call Summary may take up to a half hour to generate, but a partial summary record will be available within ten minutes of a call ending.

Call Summary properties

The following table contains the top-level properties of a single Call Summary instance.

A Call Summary is a complex data structure with several of the top-level properties constituting nested objects.

The top level contains attributes and properties objects, and each edge of a call has metrics for both directions of the media stream as well as properties and summarized metrics. Further information for these object-typed properties can be found on the Details: Call Summary page.

Whether a particular edge is present will depend on the call type. A Voice SDK call will have an sdk_edge and a client_edge. A SIP trunking call will have a sip_edge and a carrier_edge. A SIP domain or <Dial><Sip> call will have only a sip_edge. A PSTN call will have only a carrier_edge. See Understanding Twilio Media Edges for a conceptual explanation.

Resource Properties in REST API format
`account_sid`	sid<AC> Not PII The unique SID identifier of the Account.
`call_sid`	sid<CA> Not PII The unique SID identifier of the Call.
`call_type`	enum:call_type Not PII The Call Type of the summarized Call. One of `carrier`, `sip`, `trunking` or `client`.
`call_state`	enum:call_state Not PII The Call State of the summarized Call. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
`answered_by`	enum:answered_by Not PII The Answered By value for the summarized call based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to AMD for more detail.
`processing_state`	enum:processing_state Not PII The Processing State of the Call Summary. The Processing State will be `partial` until the assembly of the Call Summary finishes, which occurs approximately 30 minutes after Call end. Then the Processing State changes to `complete`
`created_time`	date_time<iso8601> Not PII The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS
`start_time`	date_time<iso8601> Not PII The time at which the Call was started, given in ISO 8601 format.
`end_time`	date_time<iso8601> Not PII The time at which the Call was ended, given in ISO 8601 format.
`duration`	integer? Not PII Duration between when the call was initiated and the call was ended
`connect_duration`	integer? Not PII Duration between when the call was answered and when it ended
`from`	object PII MTL: 30 DAYS The calling party.
`to`	object PII MTL: 30 DAYS The called party.
`carrier_edge`	object Not PII Contains metrics and properties for the Twilio media gateway of a PSTN call.
`client_edge`	object Not PII Contains metrics and properties for the Twilio media gateway of a Client call.
`sdk_edge`	object Not PII Contains metrics and properties for the SDK sensor library for Client calls.
`sip_edge`	object Not PII Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
`tags`	string[] Not PII Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
`url`	url Not PII The URL of this resource.
`attributes`	object Not PII Attributes capturing call-flow-specific details.
`properties`	object Not PII Contains edge-agnostic call-level details.
`trust`	object Not PII Contains trusted communications details including Branded Call and verified caller ID.
`annotation`	object Not PII Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API.

Fetch a Summary resource

get

https://insights.twilio.com/v1/Voice/{CallSid}/Summary

Parameters

Parameters in REST API format
`call_sid` Path	get sid<CA> Not PII The unique SID identifier of the Call.
`processing_state` Optional	get ienum:processing_state Not PII The Processing State of this Call Summary. One of `complete`, `partial` or `all`.

Parameters in REST API format

call_sid

Path

get sid<CA> Not PII

The unique SID identifier of the Call.

processing_state

Optional

get ienum:processing_state Not PII

The Processing State of this Call Summary. One of complete, partial or all.

Example 1

Loading Code Sample...

Example JSON response

Fetch a Call Summary

Example 2

Loading Code Sample...

Example JSON response

Fetch a partial Call Summary

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.