Call Annotation Resource
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
- call quality issues,
- spam labeling,
- customer-internal tags, and
- other meta data.
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.
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
|
Specifies which entity answered the call as determined by Answering Machine Detection. Possible enumerated values, one of: |
connectivity_issue
|
Specifies if the call had any connectivity issues. One of |
quality_issues
|
Specifies if the call had any subjective quality issues. Possible values are one or more of |
spam
|
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
|
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
|
Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments. |
incident
|
Incident or support ticket associated with this call. The |
url
|
|
Get the Call Annotation for a specific Call
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 the Call Annotation for a specific Call
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.
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
|
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: |
connectivity_issue
Optional
|
Specify if the call had any connectivity issues. Possible enumerated values, one of |
quality_issues
Optional
|
Specify if the call had any subjective quality issues. Possible values, one or more of |
spam
Optional
|
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 |
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. |
incident
Optional
|
Associate this call with an incident or support ticket. The |
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.