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.
A Call Annotation captures subjective experience details for a voice call.
For instance, a Call Annotation can contain information about
Using the Call Annotation Resource, you can
for a specific call.
To get a list of Call Summaries with specific Call Annotations, you can use the Call Summaries Resource.
call_sid
type: SID<CA>The unique SID identifier of the Call.
^CA[0-9a-fA-F]{32}$
34
34
account_sid
type: SID<AC>The unique SID identifier of the Account.
^AC[0-9a-fA-F]{32}$
34
34
answered_by
type: enum<string>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.
unknown_answered_by
human
machine
connectivity_issue
type: enum<string>Specifies if the call had any connectivity issues. One of no_connectivity_issue
, invalid_number
, caller_id
, dropped_call
, or number_reachability
.
unknown_connectivity_issue
no_connectivity_issue
invalid_number
caller_id
dropped_call
number_reachability
quality_issues
type: array[string]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
type: booleanSpecifies 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
type: integerSpecifies 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
type: stringSpecifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.
incident
type: stringIncident 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
type: string<uri>GET https://insights.twilio.com/v1/Voice/{CallSid}/Annotation
CallSid
type: SID<CA>The unique SID identifier of the Call.
^CA[0-9a-fA-F]{32}$
34
34
POST https://insights.twilio.com/v1/Voice/{CallSid}/Annotation
Call Annotations can be updated as long as the Call Summary record is addressable via the API.
CallSid
type: SID<CA>The unique string that Twilio created to identify this Call resource. It always starts with a CA.
^CA[0-9a-fA-F]{32}$
34
34
AnsweredBy
type: enum<string>Specify 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.
unknown_answered_by
human
machine
ConnectivityIssue
type: enum<string>Specify if the call had any connectivity issues. Possible enumerated values, one of no_connectivity_issue
, invalid_number
, caller_id
, dropped_call
, or number_reachability
.
unknown_connectivity_issue
no_connectivity_issue
invalid_number
caller_id
dropped_call
number_reachability
QualityIssues
type: stringSpecify 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
type: booleanA 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
type: integerSpecify 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
type: stringSpecify 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
type: stringAssociate 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
.