Update an Annotation for a specific Call.

POST /v1/Voice/{CallSid}/Annotation

Update an Annotation for a specific Call.

Path parameters

  • CallSid string Required

    The unique string that Twilio created to identify this Call resource. It always starts with a CA.

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

application/x-www-form-urlencoded

Body

  • AnsweredBy string | null

    Specifies which entity answered the call as determined by Answering Machine Detection. Possible enumerated values, one of: human, machine. human indicates the call was answered by a person. machine indicates the call was answered by an answering machine.

    Values are unknown_answered_by, human, or machine.

  • ConnectivityIssue string | null

    Specifies if the call had any connectivity issues. One of no_connectivity_issue, invalid_number, caller_id, dropped_call, or number_reachability.

    Values are unknown_connectivity_issue, no_connectivity_issue, invalid_number, caller_id, dropped_call, or number_reachability.

  • QualityIssues string

    Specify if the call had any subjective quality issues. Possible values, one or more of no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call.

  • Spam boolean

    A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use true if the call was a spam call.

  • CallScore integer | null

    Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

  • Comment string

    Specify any comments pertaining to the call. comment has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the comment.

  • Incident string

    Associate this call with an incident or support ticket. The incident parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in incident.

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
    • 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}$.

    • 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}$.

    • answered_by string | null

      Specifies which entity answered the call as determined by Answering Machine Detection. Possible enumerated values, one of: human, machine. human indicates the call was answered by a person. machine indicates the call was answered by an answering machine.

      Values are unknown_answered_by, human, or machine.

    • connectivity_issue string | null

      Specifies if the call had any connectivity issues. One of no_connectivity_issue, invalid_number, caller_id, dropped_call, or number_reachability.

      Values are unknown_connectivity_issue, no_connectivity_issue, invalid_number, caller_id, dropped_call, or number_reachability.

    • quality_issues array[string] | null

      Specifies if the call had any subjective quality issues. Possible values are one or more of no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, or static_noise.

    • spam boolean | null

      Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.

    • call_score integer | null

      Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

    • comment string | null

      Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.

    • incident string | null

      Incident or support ticket associated with this call. The incident property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in incident.

    • url string(uri) | null
POST /v1/Voice/{CallSid}/Annotation
curl \
 --request POST 'https://insights.twilio.com/v1/Voice/{CallSid}/Annotation' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Spam=true&Comment=this+is+a+call&Incident=https%3A%2F%2Ftwilio.zendesk.com%2Fsupport%2Ftickets%2F17353089&CallScore=2&AnsweredBy=human&QualityIssues=low_volume%2Cchoppy_robotic&ConnectivityIssue=invalid_number'
Request example
{"Spam"=>true, "Comment"=>"this is a call", "Incident"=>"https://twilio.zendesk.com/support/tickets/17353089", "CallScore"=>2, "AnsweredBy"=>"human", "QualityIssues"=>"low_volume,choppy_robotic", "ConnectivityIssue"=>"invalid_number"}
Response examples (200)
{
  "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation",
  "spam": true,
  "comment": "this is a call",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "incident": "https://twilio.zendesk.com/support/tickets/17353089",
  "call_score": 2,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "answered_by": "human",
  "quality_issues": [
    "low_volume",
    "choppy_robotic"
  ],
  "connectivity_issue": "invalid_number"
}