Call Summaries Resource
A Call Summary provides an overview of
- metadata, and
- quality metrics
for a single call.
Using the Call Summaries Resource, you can get a list of Call Summaries.
To get the Call Summary for an individual call use the Call Summary 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
|
The unique SID identifier of the Account. |
call_sid
|
The unique SID identifier of the Call. |
answered_by
|
The Answered By value for the summarized call based on |
call_type
|
The Call Type of the summarized Call. One of |
call_state
|
The Call State of the summarized Call. One of |
processing_state
|
The Processing State of the Call Summary. The Processing State will be |
created_time
|
The time at which the Call was created, given in ISO 8601 format. Can be different from |
start_time
|
The time at which the Call was started, given in ISO 8601 format. |
end_time
|
The time at which the Call was ended, given in ISO 8601 format. |
duration
|
Duration between when the call was initiated and the call was ended |
connect_duration
|
Duration between when the call was answered and when it ended |
from
|
The calling party. |
to
|
The called party. |
carrier_edge
|
Contains metrics and properties for the Twilio media gateway of a PSTN call. |
client_edge
|
Contains metrics and properties for the Twilio media gateway of a Client call. |
sdk_edge
|
Contains metrics and properties for the SDK sensor library for Client calls. |
sip_edge
|
Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call. |
tags
|
Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality. |
url
|
The URL of this resource. |
attributes
|
Attributes capturing call-flow-specific details. |
properties
|
Contains edge-agnostic call-level details. |
trust
|
Contains trusted communications details including Branded Call and verified caller ID. |
annotation
|
|
Read multiple Call Summary resources
https://insights.twilio.com/v1/Voice/Summaries
Parameters
| Parameters in REST API format | |
|---|---|
from
Optional
|
A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name. |
to
Optional
|
A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name. |
from_carrier
Optional
|
An origination carrier. |
to_carrier
Optional
|
A destination carrier. |
from_country_code
Optional
|
A source country code based on phone number in From. |
to_country_code
Optional
|
A destination country code. Based on phone number in To. |
branded
Optional
|
A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls. |
verified_caller
Optional
|
A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR. |
has_tag
Optional
|
A boolean flag indicating the presence of one or more Voice Insights Call Tags. |
start_time
Optional
|
A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h. |
end_time
Optional
|
An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m. |
call_type
Optional
|
A Call Type of the calls. One of |
call_state
Optional
|
A Call State of the calls. One of |
direction
Optional
|
A Direction of the calls. One of |
processing_state
Optional
|
A Processing State of the Call Summaries. One of |
sort_by
Optional
|
A Sort By criterion for the returned list of Call Summaries. One of |
subaccount
Optional
|
A unique SID identifier of a Subaccount. |
abnormal_session
Optional
|
A boolean flag indicating an abnormal session where the last SIP response was not 200 OK. |
answered_by
Optional
|
An Answered By value for the calls based on |
answered_by_annotation
Optional
|
Either machine or human. |
connectivity_issue_annotation
Optional
|
A Connectivity Issue with the calls. One of |
quality_issue_annotation
Optional
|
A subjective Quality Issue with the calls. One of |
spam_annotation
Optional
|
A boolean flag indicating spam calls. |
call_score_annotation
Optional
|
A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]. |
Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
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.
