Skip to content Skip to navigation Skip to topbar

Twilio Docs

Voice Insights Back to Programmable Voice Voice Insights Overview

Console Features

Call Insights

Call Insights Dashboard Subaccount Call Insights Dashboard Call Summary

Conference Insights

Conference Insights Dashboard Conference and Participant Summary

Voice Insights Advanced Features

Event Streams

Event Streams Overview Call Insights Event Stream Conference Insights Event Stream

REST API Reference

Voice Insights API Overview

Call Insights

API Overview Call Summary Resource Call Summaries Resource Call Insights Event Resource Call Metric Resource Call Annotation Resource Voice Insights Settings Resource Details: Call Summary Details: Call Tags Details: Voice Insights SDK Events Understanding Twilio Media Edges

Conference Insights

API Overview Conference Summary Resource Conference Participant Summary Resource

FAQs

Voice Insights Frequently Asked Questions

Messaging
Voice
Serverless
Flex
Studio
All docs...

SDKs
Help

Log in
Sign up

Rate this page:

12345

On this page

Call Summary properties
Fetch a Summary resource

Call Summary properties

Fetch a Summary resource

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.

(warning)

Warning

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

(information)

Info

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

account_sidtype: SID<AC>

The unique SID identifier of the Account.

Pattern:

^AC[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

call_sidtype: SID<CA>

The unique SID identifier of the Call.

Pattern:

^CA[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

call_typetype: enum<string>

The Call Type of the summarized Call. One of carrier, sip, trunking or client.

Possible values:

carriersiptrunkingclient

call_statetype: enum<string>

The Call State of the summarized Call. One of ringing, completed, busy, fail, noanswer, canceled, answered, undialed.

Possible values:

ringingcompletedbusyfailnoanswercanceledansweredundialed

answered_bytype: enum<string>

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.

Possible values:

unknownmachine_startmachine_end_beepmachine_end_silencemachine_end_otherhumanfax

processing_statetype: enum<string>

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

Possible values:

completepartial

created_timetype: string<date-time>

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_timetype: string<date-time>

The time at which the Call was started, given in ISO 8601 format.

end_timetype: string<date-time>

The time at which the Call was ended, given in ISO 8601 format.

durationtype: integer

Duration between when the call was initiated and the call was ended

connect_durationtype: integer

Duration between when the call was answered and when it ended

fromtype: object

PII MTL: 30 days

The calling party.

totype: object

PII MTL: 30 days

The called party.

carrier_edgetype: object

Contains metrics and properties for the Twilio media gateway of a PSTN call.

client_edgetype: object

Contains metrics and properties for the Twilio media gateway of a Client call.

sdk_edgetype: object

Contains metrics and properties for the SDK sensor library for Client calls.

sip_edgetype: object

Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.

tagstype: array[string]

Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.

urltype: string<uri>

The URL of this resource.

attributestype: object

Attributes capturing call-flow-specific details.

propertiestype: object

Contains edge-agnostic call-level details.

trusttype: object

Contains trusted communications details including Branded Call and verified caller ID.

annotationtype: object

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

URI parameters

CallSidtype: SID<CA>

Path ParameterNot PII

The unique SID identifier of the Call.

Pattern:

^CA[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

ProcessingStatetype: enum<string>

Query ParameterNot PII

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

Possible values:

completepartial

Fetch a Call Summary

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11
_11client.insights.v1.calls('CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11                  .summary()
_11                  .fetch()
_11                  .then(call_summary => console.log(call_summary.to));

Output


_39{
_39  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_39  "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_39  "call_type": "carrier",
_39  "call_state": "ringing",
_39  "answered_by": "machine_start",
_39  "processing_state": "complete",
_39  "created_time": "2015-07-30T20:00:00Z",
_39  "start_time": "2015-07-30T20:00:00Z",
_39  "end_time": "2015-07-30T20:00:00Z",
_39  "duration": 100,
_39  "connect_duration": 99,
_39  "from": {},
_39  "to": {},
_39  "carrier_edge": {},
_39  "client_edge": {},
_39  "sdk_edge": {},
_39  "sip_edge": {},
_39  "tags": [
_39    "tags"
_39  ],
_39  "attributes": {},
_39  "properties": {},
_39  "trust": {},
_39  "annotation": {
_39    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_39    "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_39    "answered_by": "human",
_39    "connectivity_issue": "invalid_number",
_39    "quality_issues": [
_39      "low_volume"
_39    ],
_39    "spam": true,
_39    "call_score": 2,
_39    "comment": "this is a call",
_39    "incident": "https://twilio.zendesk.com/support/tickets/17353089"
_39  },
_39  "url": "https://insights.twilio.com/v1/Voice/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Summary"
_39}

Fetch a partial Call Summary

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11
_11client.insights.v1.calls('CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11                  .summary()
_11                  .fetch({processingState: 'partial'})
_11                  .then(call_summary => console.log(call_summary.to));

Output


_39{
_39  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_39  "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_39  "call_type": "carrier",
_39  "call_state": "ringing",
_39  "answered_by": "machine_start",
_39  "processing_state": "partial",
_39  "created_time": "2015-07-30T20:00:00Z",
_39  "start_time": "2015-07-30T20:00:00Z",
_39  "end_time": "2015-07-30T20:00:00Z",
_39  "duration": 100,
_39  "connect_duration": 99,
_39  "from": {},
_39  "to": {},
_39  "carrier_edge": {},
_39  "client_edge": {},
_39  "sdk_edge": {},
_39  "sip_edge": {},
_39  "tags": [
_39    "tags"
_39  ],
_39  "attributes": {},
_39  "properties": {},
_39  "trust": {},
_39  "annotation": {
_39    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_39    "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_39    "answered_by": "human",
_39    "connectivity_issue": "invalid_number",
_39    "quality_issues": [
_39      "low_volume"
_39    ],
_39    "spam": true,
_39    "call_score": 2,
_39    "comment": "this is a call",
_39    "incident": "https://twilio.zendesk.com/support/tickets/17353089"
_39  },
_39  "url": "https://insights.twilio.com/v1/Voice/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Summary"
_39}

Rate this page:

12345

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.

Terms of service

Copyright © 2024 Twilio Inc.