Call Annotation Resource
Call Annotation is in Beta
Currently the Call Annotation API is only available for the United States (US1) Region. Find more information on the Twilio Regional Product and Feature Availability page.
The Call Annotation Resource provides the capability to programmatically provide subjective experience details including call quality issues, spam labeling, and customer-internal tags and metadata for a single call. Annotations can be updated as long as the Call Summary record is addressable via the API.
Annotation properties
| Resource Properties in REST API format | |
|---|---|
call_sid
|
The unique SID identifier of the Call. |
account_sid
|
The unique SID identifier of the Account. |
answered_by
|
Which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. 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. |
connectivity_issue
|
Specify if the call had any connectivity issues. Possible enumerated values, one : no_connectivity_issue, invalid_number, caller_id, dropped_call, number_reachability. |
quality_issues
|
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
|
Specify 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
|
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
|
Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here. |
incident
|
Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here. |
url
|
The URL of this resource. |
Fetch an Annotation resource
https://insights.twilio.com/v1/Voice/{CallSid}/Annotation
Parameters
| Parameters in REST API format | |
|---|---|
call_sid
Path
|
The unique SID identifier of the Call. |
Example 1
Update an Annotation resource
https://insights.twilio.com/v1/Voice/{CallSid}/Annotation
Parameters
| Parameters in REST API format | |
|---|---|
call_sid
Path
|
The unique string that Twilio created to identify this Call resource. It always starts with a CA. |
answered_by
Optional
|
Which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. 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. |
connectivity_issue
Optional
|
Specify if the call had any connectivity issues. Possible enumerated values, one : no_connectivity_issue, invalid_number, caller_id, dropped_call, number_reachability. |
quality_issues
Optional
|
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
Optional
|
Specify 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
Optional
|
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
Optional
|
Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here. |
incident
Optional
|
Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
