Update an Annotation for a specific Call.
Update an Annotation for a specific Call.
Path parameters
-
The unique string that Twilio created to identify this Call resource. It always starts with a CA.
Minimum length is
34
, maximum length is34
. Format should match the following pattern:^CA[0-9a-fA-F]{32}$
.
Body
-
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
, ormachine
. -
Specifies if the call had any connectivity issues. One of
no_connectivity_issue
,invalid_number
,caller_id
,dropped_call
, ornumber_reachability
.Values are
unknown_connectivity_issue
,no_connectivity_issue
,invalid_number
,caller_id
,dropped_call
, ornumber_reachability
. -
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. -
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. -
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].
-
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 thecomment
. -
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 inincident
.
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'
{"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"}
{
"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"
}