GET /v1/Voice/Summaries

twilio.com:twilio_insights_v1

Summary:
Operation ID: ListCallSummaries
Auth: unknown
Description

Get a list of Call Summaries.

Parameters (27)

AbnormalSession (boolean, query, optional)

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

AnsweredBy (string, query, optional)

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`.

AnsweredByAnnotation (string, query, optional)

Either machine or human.

Branded (boolean, query, optional)

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

CallScoreAnnotation (string, query, 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].

CallState (string, query, optional)

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

CallType (string, query, optional)

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

ConnectivityIssueAnnotation (string, query, optional)

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

Direction (string, query, optional)

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

EndTime (string, query, 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.

From (string, query, optional)

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

FromCarrier (string, query, optional)

An origination carrier.

FromCountryCode (string, query, optional)

A source country code based on phone number in From.

HasTag (boolean, query, optional)

A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).

Page (integer, query, optional)

The page index. This value is simply for client state.

Constraints: {'minimum': 0}

PageSize (integer, query, optional)

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Constraints: {'minimum': 1, 'maximum': 1000}

PageToken (string, query, optional)

The page token. This is provided by the API.

ProcessingState (string, query, optional)

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

QualityIssueAnnotation (string, query, optional)

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

SortBy (string, query, optional)

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

SpamAnnotation (boolean, query, optional)

A boolean flag indicating spam calls.

StartTime (string, query, 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.

Subaccount (string, query, optional)

A unique SID identifier of a Subaccount.

Constraints: {'minLength': 34, 'maxLength': 34, 'pattern': '^AC[0-9a-fA-F]{32}$'}

To (string, query, optional)

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

ToCarrier (string, query, optional)

A destination carrier.

ToCountryCode (string, query, optional)

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

VerifiedCaller (boolean, query, optional)

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

No probe data for this endpoint yet.