A Call Summary provides an overview of
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.
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.
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.
unknown
machine_start
machine_end_beep
machine_end_silence
machine_end_other
human
fax
The Call Type of the summarized Call. One of carrier
, sip
, trunking
or client
.
carrier
sip
trunking
client
The Call State of the summarized Call. One of ringing
, completed
, busy
, fail
, noanswer
, canceled
, answered
, undialed
.
ringing
completed
busy
fail
noanswer
canceled
answered
undialed
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
complete
partial
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
The time at which the Call was started, given in ISO 8601 format.
The time at which the Call was ended, given in ISO 8601 format.
Contains metrics and properties for the Twilio media gateway of a PSTN call.
Contains metrics and properties for the Twilio media gateway of a Client call.
Contains metrics and properties for the SDK sensor library for Client calls.
Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
Contains trusted communications details including Branded Call and verified caller ID.
GET https://insights.twilio.com/v1/Voice/Summaries
A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
A source country code based on phone number in From.
A destination country code. Based on phone number in To.
A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.
A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.
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.
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.
A Call Type of the calls. One of carrier
, sip
, trunking
or client
.
A Call State of the calls. One of ringing
, completed
, busy
, fail
, noanswer
, canceled
, answered
, undialed
.
A Direction of the calls. One of outbound_api
, outbound_dial
, inbound
, trunking_originating
, trunking_terminating
.
A Processing State of the Call Summaries. One of completed
, partial
or all
.
completed
started
partial
all
A Sort By criterion for the returned list of Call Summaries. One of start_time
or end_time
.
start_time
end_time
A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
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
.
unknown
machine_start
machine_end_beep
machine_end_silence
machine_end_other
human
fax
A Connectivity Issue with the calls. One of no_connectivity_issue
, invalid_number
, caller_id
, dropped_call
, or number_reachability
.
A subjective Quality Issue with the calls. One of no_quality_issue
, low_volume
, choppy_robotic
, echo
, dtmf
, latency
, owa
, static_noise
.
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].
How many resources to return in each list page. The default is 50, and the maximum is 1000.