Menu

Expand
Rate this page:

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
sid<AC> Not PII

The unique SID identifier of the Account.

call_sid
sid<CA> Not PII

The unique SID identifier of the Call.

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.

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.

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

The calling party.

to

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

Read multiple Call Summary resources

get
https://insights.twilio.com/v1/Voice/Summaries
Parameters
Parameters in REST API format
from
Optional
get string PII MTL: 30 DAYS

A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.

to
Optional
get string PII MTL: 30 DAYS

A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.

from_carrier
Optional
get string Not PII

An origination carrier.

to_carrier
Optional
get string Not PII

A destination carrier.

from_country_code
Optional
get string Not PII

A source country code based on phone number in From.

to_country_code
Optional
get string Not PII

A destination country code. Based on phone number in To.

branded
Optional
get boolean Not PII

A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.

verified_caller
Optional
get boolean Not PII

A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.

has_tag
Optional
get boolean Not PII

A boolean flag indicating the presence of one or more Voice Insights Call Tags.

start_time
Optional
get string Not PII

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
get string Not PII

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
get string Not PII

A Call Type of the calls. One of carrier, sip, trunking or client.

call_state
Optional
get string Not PII

A Call State of the calls. One of ringing, completed, busy, fail, noanswer, canceled, answered, undialed.

direction
Optional
get string Not PII

A Direction of the calls. One of outbound_api, outbound_dial, inbound, trunking_originating, trunking_terminating.

processing_state
Optional
get ienum:processing_state_request Not PII

A Processing State of the Call Summaries. One of completed, partial or all.

sort_by
Optional
get ienum:sort_by Not PII

A Sort By criterion for the returned list of Call Summaries. One of start_time or end_time.

subaccount
Optional
get sid<AC> Not PII

A unique SID identifier of a Subaccount.

abnormal_session
Optional
get boolean Not PII

A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.

answered_by
Optional
get ienum:answered_by Not PII

An Answered By value for the calls based on Answering Machine Detection (AMD). One of unknown, machine_start, machine_end_beep, machine_end_silence, machine_end_other, human or fax.

answered_by_annotation
Optional
get string Not PII

Either machine or human.

connectivity_issue_annotation
Optional
get string Not PII

A Connectivity Issue with the calls. One of no_connectivity_issue, invalid_number, caller_id, dropped_call, or number_reachability.

quality_issue_annotation
Optional
get string Not PII

A subjective Quality Issue with the calls. One of no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise.

spam_annotation
Optional
get boolean Not PII

A boolean flag indicating spam calls.

call_score_annotation
Optional
get string Not PII

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
Loading Code Sample...
        
        

        Read multiple Call Summaries

        Example 2
        Loading Code Sample...
              
              

              Read multiple Call Summaries from to/from specific carriers for a data range

              Example 3
              Loading Code Sample...
                    
                    

                    Read multiple Call Summaries from a subaccount with detected issues

                    Example 4
                    Loading Code Sample...
                          
                          

                          Read multiple Call Summaries for outbound calls signed with SHAKEN/STIR

                          Example 5
                          Loading Code Sample...
                                
                                

                                Read multiple Call Summaries for SIP calls which did not end in 200 OK

                                Example 6
                                Loading Code Sample...
                                      
                                      

                                      Read multiple Call Summaries with annotations

                                      Rate this page:

                                      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.

                                      Loading Code Sample...
                                            
                                            
                                            

                                            Thank you for your feedback!

                                            Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                                            Sending your feedback...
                                            🎉 Thank you for your feedback!
                                            Something went wrong. Please try again.

                                            Thanks for your feedback!

                                            thanks-feedback-gif