Sign in
InsightsV1CallSummaries

Get a list of Call Summaries.

Get a list of Call Summaries.

get/v1/Voice/Summaries

Query parameters

Fromstring

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

Tostring

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

FromCarrierstring

An origination carrier.

ToCarrierstring

A destination carrier.

FromCountryCodestring

A source country code based on phone number in From.

ToCountryCodestring

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

VerifiedCallerboolean

A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.One of 'true' or 'false'.

HasTagboolean

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

StartTimestring

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.

EndTimestring

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.

CallTypestring

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

CallStatestring

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

Directionstring

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

ProcessingState'completed' | 'started' | 'partial' | 'all'

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

SortBy'start_time' | 'end_time'

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

Subaccountstring

A unique SID identifier of a Subaccount.

AbnormalSessionboolean

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

AnsweredBy'unknown' | 'machine_start' | 'machine_end_beep' | 'machine_end_silence' | 'machine_end_other' | 'human' | 'fax'

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.

AnsweredByAnnotationstring

Either machine or human.

ConnectivityIssueAnnotationstring

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

QualityIssueAnnotationstring

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

SpamAnnotationboolean

A boolean flag indicating spam calls.

CallScoreAnnotationstring

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

BrandedEnabledboolean

A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls. One of 'true' or 'false'

VoiceIntegrityEnabledboolean

A boolean flag indicating whether or not the phone number had voice integrity enabled.One of 'true' or 'false'

BrandedBundleSidstring

A unique SID identifier of the Branded Call.

BrandedLogoboolean

Indicates whether the branded logo was displayed during the in_brand branded call. Possible values are true (logo was present) or false (logo was not present).

BrandedTypestring

Indicates whether the Branded Call is in_band vs out_of_band.

BrandedUseCasestring

Specifies the user-defined purpose for the call, as provided during the setup of in_band branded calling.

BrandedCallReasonstring

Specifies the user-defined reason for the call, which will be displayed to the end user on their mobile device during an in_band branded call.

VoiceIntegrityBundleSidstring

A unique SID identifier of the Voice Integrity Profile.

VoiceIntegrityUseCasestring

A Voice Integrity Use Case . Is of type enum. One of 'abandoned_cart', 'appointment_reminders', 'appointment_scheduling', 'asset_management', 'automated_support', 'call_tracking', 'click_to_call', 'contact_tracing', 'contactless_delivery', 'customer_support', 'dating/social', 'delivery_notifications', 'distance_learning', 'emergency_notifications', 'employee_notifications', 'exam_proctoring', 'field_notifications', 'first_responder', 'fraud_alerts', 'group_messaging', 'identify_&verification', 'intelligent_routing', 'lead_alerts', 'lead_distribution', 'lead_generation', 'lead_management', 'lead_nurturing', 'marketing_events', 'mass_alerts', 'meetings/collaboration', 'order_notifications', 'outbound_dialer', 'pharmacy', 'phone_system', 'purchase_confirmation', 'remote_appointments', 'rewards_program', 'self-service', 'service_alerts', 'shift_management', 'survey/research', 'telehealth', 'telemarketing', 'therapy(individual+group)'.

BusinessProfileIdentitystring

A Business Identity of the calls. Is of type enum. One of 'direct_customer', 'isv_reseller_or_partner'.

BusinessProfileIndustrystring

A Business Industry of the calls. Is of type enum. One of 'automotive', 'agriculture', 'banking', 'consumer', 'construction', 'education', 'engineering', 'energy', 'oil_and_gas', 'fast_moving_consumer_goods', 'financial', 'fintech', 'food_and_beverage', 'government', 'healthcare', 'hospitality', 'insurance', 'legal', 'manufacturing', 'media', 'online', 'professional_services', 'raw_materials', 'real_estate', 'religion', 'retail', 'jewelry', 'technology', 'telecommunications', 'transportation', 'travel', 'electronics', 'not_for_profit'

BusinessProfileBundleSidstring

A unique SID identifier of the Business Profile.

BusinessProfileTypestring

A Business Profile Type of the calls. Is of type enum. One of 'primary', 'secondary'.

PageSizeinteger

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

Pageinteger

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

PageTokenstring

The page token. This is provided by the API.

Response

OK

Changes

Changed in 9 of the 51 revisions of this API.22924

  • v1f61c549dd40c11See the full diff
    • ▲

      for the query request parameter PageSize, the max was decreased from 1000.00 to 25.00

      request-parameter-max-decreased

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • v10c1d9c8a044110See the full diff
    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

  • v10c09e77f70984See the full diff
    • ○

      added the new optional query request parameter BrandedCallReason

      new-optional-request-parameter

    • ○

      added the new optional query request parameter BrandedLogo

      new-optional-request-parameter

    • ○

      added the new optional query request parameter BrandedType

      new-optional-request-parameter

    • ○

      added the new optional query request parameter BrandedUseCase

      new-optional-request-parameter

  • v1b62ede4d8adc10See the full diff
    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

  • v1cd57d6a65e2d1See the full diff
    • ▲

      for the query request parameter PageSize, the format changed from no format to int64

      request-parameter-type-changed

  • v1f5faa6aa1fbc1See the full diff
    • ●

      added the new whatsapp enum value to the // response property for the response status

      response-property-enum-value-added

  • v1aeed4dc6d37419See the full diff
    • ●

      deleted the query request parameter Branded

      request-parameter-removed

    • ○

      added the new optional query request parameter BrandedBundleSid

      new-optional-request-parameter

    • ○

      added the new optional query request parameter BrandedEnabled

      new-optional-request-parameter

    • ○

      added the new optional query request parameter BusinessProfileBundleSid

      new-optional-request-parameter

    • ○

      added the new optional query request parameter BusinessProfileIdentity

      new-optional-request-parameter

    • ○

      added the new optional query request parameter BusinessProfileIndustry

      new-optional-request-parameter

    • ○

      added the new optional query request parameter BusinessProfileType

      new-optional-request-parameter

    • ○

      added the new optional query request parameter VoiceIntegrityBundleSid

      new-optional-request-parameter

    • ○

      added the new optional query request parameter VoiceIntegrityEnabled

      new-optional-request-parameter

    • ○

      added the new optional query request parameter VoiceIntegrityUseCase

      new-optional-request-parameter

  • v1fd83d6640ffd46See the full diff
    • ●

      deleted the query request parameter CallScore

      request-parameter-removed

    • ●

      deleted the query request parameter ConnectivityIssue

      request-parameter-removed

    • ●

      deleted the query request parameter QualityIssue

      request-parameter-removed

    • ●

      deleted the query request parameter Spam

      request-parameter-removed

    • ○

      api tag InsightsV1CallSummaries added

      api-tag-added

    • ○

      added the new optional query request parameter AnsweredByAnnotation

      new-optional-request-parameter

    • ○

      added the new optional query request parameter CallScoreAnnotation

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ConnectivityIssueAnnotation

      new-optional-request-parameter

    • ○

      added the new optional query request parameter QualityIssueAnnotation

      new-optional-request-parameter

    • ○

      added the new optional query request parameter SpamAnnotation

      new-optional-request-parameter

  • v16b745ef0638234See the full diff
    • ●

      deleted the query request parameter CallScores

      request-parameter-removed

    • ●

      deleted the query request parameter ConnectivityIssues

      request-parameter-removed

    • ●

      deleted the query request parameter QualityIssues

      request-parameter-removed

    • ○

      added the new optional query request parameter CallScore

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ConnectivityIssue

      new-optional-request-parameter

    • ○

      added the new optional query request parameter QualityIssue

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added