TWtwilio
InsightsV1Annotation

Update an Annotation for a specific Call.

Changed on

Update an Annotation for a specific Call.

post/v1/Voice/{CallSid}/Annotation

Request

  • Base URL
    https://insights.twilio.com
  • URL
    https://insights.twilio.com/v1/Voice/{CallSid}/Annotation
  • Auth
    HTTP basic

Path parameters

CallSidstring required

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

Request body application/x-www-form-urlencoded

AnsweredBy'unknown_answered_by' | 'human' | 'machine'
ConnectivityIssue'unknown_connectivity_issue' | 'no_connectivity_issue' | 'invalid_number' | 'caller_id' | 'dropped_call' | 'number_reachability'
QualityIssuesstring

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.

Spamboolean

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.

CallScoreinteger nullable

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

Commentstring

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.

Incidentstring

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.

Response

OK

call_sidstring nullable

The unique SID identifier of the Call.

account_sidstring nullable

The unique SID identifier of the Account.

answered_by'unknown_answered_by' | 'human' | 'machine'
connectivity_issue'unknown_connectivity_issue' | 'no_connectivity_issue' | 'invalid_number' | 'caller_id' | 'dropped_call' | 'number_reachability'
quality_issuesstring[] nullable

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.

spamboolean nullable

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_scoreinteger nullable

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

commentstring nullable

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

incidentstring nullable

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.

urlstring uri nullable

Changes