Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Details: Call Summary



Working with a Call Summary

working-with-a-call-summary page anchor

Call Summaries as obtainable from the Call Summary Resource (single summary) and Call Summaries Resource (list of summaries) are fairly deep data structures. Several of the top-level properties are nested objects. This supplementary API documentation page provides additional details about these nested objects.

Not all applications will require that level of detail. For example, if all you need to know is whether or not jitter was detected on the call, then checking the top-level tags will provide the answer. However, if you want to know the maximum jitter sampled on the outbound media stream of a specific Client call, then it may be necessary to access nested information such as client_edge.metrics.outbound.jitter.max

SectionDescription
Properties objectDetails for the top-level properties object of a Call Summary.
Attributes objectDetails for the top-level attributes object of a Call Summary.
To/From objectDetails for the top-level to and from object of a Call Summary.
SDK objectDetails for the top-level sdk object of Call Summary.
Edges and their propertiesBackground and details for top-level properties of a Call Summary related to the edges of a call and their respective properties, metrics and events objects.
Trust objectDetails for the top-level trust object of a Call Summary.
Annotation objectDetails for the top-level annotation object of a Call Summary.

Edge-agnostic call-level details.

PropertyDescription
pdd_msPost-dial delay in milliseconds
last_sip_response_numThe numeric value of the last SIP response received for the call
directionThe direction of the call; inbound, outbound-api, outbound-dial, trunking-originating, trunking-terminating
disconnected_byDirection of the SIP BYE received at Twilio signaling gateway.
queue_timeEstimated time in milliseconds between when a Programmable Voice call is created and when the call actually begins.

Call-flow specific details.

PropertyDescription
conference_participantTrue/false. Indicates if primary media source was a Twilio conference mixer.

Additional metadata for Voice SDK calls.

PropertyDescription
calleeDialed destination.
callerCaller ID of calling party.
carrierServing carrier of destination
connectionConnection type landline, mobile, voip
country_codeTwo-letter ISO country code
country_subdivisionAdditional location details; e.g. California
cityCity name based on lat/long or IP address
locationLat/long for number prefix
ip_addressPublic IP of Client user
number_prefixE.164 country code + three digits

Additional metadata for Voice SDK calls.

PropertyDescription
typeVersion of Twilio SDK; e.g. twilio-js-sdk. twilio-voice-android
versionTwilio SDK version
platformWebRTC, android, iOS
regionThe Twilio region the device registered to
selected_regionThe region specified in the device setup
edge_locationThe edge location specified
browser.nameName of browser for calls placed using JavaScript SDK
browser.majorMajor version of browser
browser.versionFull version of browser
os.nameOperating system name as reported to the SDK
os.versionOperating system version as reported to the SDK
device.archProcessor architecture of machine running the Client app; e.g. amd64
device.modelMobile SDKs only: model name/number reported to the SDK
device.typeMobile SDKs only: device type reported to the SDK
device.vendorMobile SDKs only: hardware manufacturer reported to the SDK
engine.nameJavaScript SDK only: browser engine as detected by the SDK
engine.versionJavaScript SDK only: browser engine version detected by the SDK

Edges and their properties

edges-and-their-properties page anchor

There are four possible edges: carrier_edge, client_edge, sdk_edge, and sip_edge. SIP trunking calls will have both a carrier_edge and a sip_edge. Client calls will have both an sdk_edge and a client_edge.

carrier_edge represents the connection between Twilio and our immediate carrier partners. The metrics here describe the media stream metadata as it was received from the carrier on the inbound, and as it was delivered to the carrier on the outbound.

client_edge represents the Twilio media gateway for Client calls. The metrics here describe the media stream metadata as it was received from the Client SDK application on the inbound, and as it was sent to the Client SDK application on the outbound.

(warning)

Warning

Voice Insights for mobile SDKs is supported for versions 3.x and later. Calls placed using 2.x mobile SDKs are not supported and details are provided as-is and may not be reliable indicators of actual performance on the handset or subjective experience on the call.

sip_edge represents the Twilio media gateway for SIP interface and SIP trunking calls. The metrics here describe what was received from your SIP infrastructure on the inbound, and what was delivered to your SIP infrastructure on the outbound.

Each edge has two child objects: metrics and properties. metrics will have a container for inbound and outbound media streams.

Edge Metrics object

edge-metrics-object page anchor
PropertyDescription
codecRTP profile number for the media codec
codec_nameName of the media codec
packets_receivedCount of packets received; inbound container only
packets_sentCount of packets sent; outbound container only
packets_lostCount of packets lost
packets_loss_percentagePercentage of packets lost
jitteraverage and max jitter detected
latencyTwilio internal RTP traversal time from ingress to egress. average and max latency detected.
packet_delay_variationDistribution of packets delayed by a certain value; e.g. "d50": 24 indicates that 24 packets were delayed by more than 50 ms.
PropertyDescription
q850_causeITU-T Q.850 standard definition of telephony disconnect cause. Not available for all edge types or all calls.
directionDirection of media flow from the perspective of the edge. Inbound or outbound.
media_regionThe Twilio region where media was handled.
signaling_regionThe Twilio region where signaling was handled.
edge_locationThe Twilio edge location where media was handled.
twilio_media_ipThe IP address for Twilio's media gateway. Not available for carrier_edge.
twilio_signaling_ipThe IP address for Twilio's signaling gateway. Not available for carrier_edge.
external_media_ipThe IP address Twilio received media from. Not available for carrier_edge.
external_signaling_ipThe IP address Twilio received signaling from. Not available for carrier_edge.
sip_call_idSIP call ID for the call between Twilio & your SIP infrastructure. Present on SIP Interface and trunking calls only.
user_agentAvailable for trunking calls only.
selected_regionAvailable for Client calls only.
regionAvailable for Client calls only.
disconnected_byAvailable for Client calls only. Identifies if Twilio.Device.disconnect() was called in the local application or if the call was ended by remote party.
trunk_sidThe trunk SID for this call. Present on trunking calls only.

sdk_edge represents the sensor library in the SDK application itself. The metrics here describe the media stream that was received at the SDK from the Twilio media gateway. Packet loss, jitter, MOS, and RTT are reporting on the inbound stream to the SDK. Audio in/audio out levels can be used to detect one-way audio; no audio in indicates an issue with microphone, potentially muting, hardware issue, or browser loss of context for OS audio APIs.

PropertyDescription
mosMean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Average, maximum, and minimum values returned.
rttRound-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. Average, maximum, and minimum values returned.
packets_receivedCount of packets received; inbound container only.
packets_sentCount of packets sent; outbound container only.
packets_lostCount of packets lost.
packets_loss_percentagePercentage of packets lost.
jitterAverage and max jitter detected.
tagsTags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
bytes_receivedBytes received at the SDK sensors.
bytes_sentBytes sent from the SDK.
inbound.audio_outavg/max level for speaker audio.
inbound.audio_inavg/max level for microphone audio.
outbound.codec_nameFriendly name of the RTP codec for the call set in Twilio.Device().
outbound.codecRTP profile number of the codec for the call set in Twilio.Device().

SDK Edge Properties object

sdk-edge-properties-object page anchor

The sdk_edge property of a Call Summary has a properties property the following nested properties.

PropertyDescription
directionDirection of the call from the perspective of the SDK.
settings.dscpIndicates whether DSCP was enabled.
settings.ice_restart_enabledIndicates if ICE restart was enabled.
settings.edgeTwilio Edge Location that was used for this call.
settings.selected_edgesPrioritized list of Edge Locations provided during Twilio.Device.setup().

The sdk_edge property of a Call Summary has an events property the following nested properties.

PropertyDescription
levelsCount of events by severity for the call.
groupsCount of events by the event group.
errorsError code and number of occurrences.
feedbackUser feedback gathered from the SDK.

The trust property of a Call Summary has the following object properties.

PropertyDescription
branded_call.brandedBoolean. Indicates if branding details were successfully displayed on the destination device.
branded_call.callerCaller ID provided.
branded_call.use_caseUse case for the call.
branded_call.branded_channel_sidBranded channel SID.
branded_call.business_sidBusiness SID.
branded_call.brand_sidBrand SID.
verified_caller.verifiedBoolean. Indicates if the caller ID provided has been verified; e.g. SHAKEN/STIR A attestation.

Each Call Summary can be programatically labeled by the developers to add subjective information pertaining to the summarized call. Please refer to the Call Annotation Resource page for more details.

PropertyDescription
answered_byEnumerated. Which entity answered the call as determined by Answering Machine Detection (AMD). Use this to provide feedback on AMD accuracy.
connectivity_issueEnumerated. Indicates if the call was labeled for any connectivity issues.
quality_issuesString[]. Indicates if the call was labeled for user perceived quality issues.
spamBoolean. Indicates if the call was labeled as a spam call.
call_scoreInteger. Indicates the labeled call score for that call.
commentString. Indicates if any comments were added for the call.
incidentString. Indicates if any associated incident or support tickets were added for the call.

Rate this Page: