GET /v1/Voice/{CallSid}/Summary

Get a specific Call Summary.

Path parameters

  • CallSid string Required

    The unique SID identifier of the Call.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

Query parameters

  • ProcessingState string

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

    Values are complete or partial.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The unique SID identifier of the Account.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • call_sid string | null

      The unique SID identifier of the Call.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

    • call_type string

      Values are carrier, sip, trunking, client, or whatsapp.

    • call_state string

      Values are ringing, completed, busy, fail, noanswer, canceled, answered, or undialed.

    • answered_by string

      Values are unknown, machine_start, machine_end_beep, machine_end_silence, machine_end_other, human, or fax.

    • processing_state string

      Values are complete or partial.

    • created_time string(date-time) | null

      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_time string(date-time) | null

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

    • end_time string(date-time) | null

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

    • duration integer | null

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

    • connect_duration integer | null

      Duration between when the call was answered and when it ended

    • from object | null

      The calling party.

    • to object | null

      The called party.

    • carrier_edge object | null

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

    • client_edge object | null

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

    • sdk_edge object | null

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

    • sip_edge object | null

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

    • tags array[string] | null

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

    • url string(uri) | null

      The URL of this resource.

    • attributes object | null

      Attributes capturing call-flow-specific details.

    • properties object | null

      Contains edge-agnostic call-level details.

    • trust object | null

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

    • annotation object | null

      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.

GET /v1/Voice/{CallSid}/Summary
curl \
 --request GET 'https://insights.twilio.com/v1/Voice/{CallSid}/Summary' \
 --user "username:password"
Response examples (200)
{
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_type": "carrier",
  "call_state": "ringing",
  "answered_by": "machine_start",
  "processing_state": "complete",
  "created_time": "2015-07-30T20:00:00Z",
  "start_time": "2015-07-30T20:00:00Z",
  "end_time": "2015-07-30T20:00:00Z",
  "duration": 100,
  "connect_duration": 99,
  "from": {},
  "to": {},
  "carrier_edge": {},
  "client_edge": {},
  "sdk_edge": {},
  "sip_edge": {},
  "tags": [
    "tags"
  ],
  "attributes": {},
  "properties": {},
  "trust": {
    "verified_caller": {
      "verified": true
    },
    "branded": {
      "enabled": true,
      "display_name": "Owl bank",
      "long_display_name": "Owl bank Ltd",
      "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167",
      "logo": true,
      "type": "in_band",
      "use_case": "Customer Care",
      "call_reason": "Branded CTIA"
    },
    "business_profile": {
      "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167",
      "identity": "direct_customer",
      "industry": "BANKING",
      "type": "corporate"
    },
    "voice_integrity": {
      "enabled": true,
      "bundle_sid": "BU5ceeea51b1424478fc541dfef0e2b167",
      "use_case": "customer_support"
    }
  },
  "annotation": {
    "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "answered_by": "human",
    "connectivity_issue": "invalid_number",
    "quality_issues": [
      "low_volume"
    ],
    "spam": true,
    "call_score": 2,
    "comment": "this is a call",
    "incident": "https://twilio.zendesk.com/support/tickets/17353089"
  },
  "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary"
}