メニュー

Expand
ページを評価:

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
sid<CA> Not PII

The unique SID identifier of the Call.

account_sid
sid<AC> Not PII

The unique SID identifier of the Account.

answered_by
enum:answered_by Not PII

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
enum:connectivity_issue Not PII

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
string[] Not PII

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
boolean Not PII

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
integer? Not PII

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
文字列 Not PII

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
文字列 Not PII

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
url Not PII

The URL of this resource.

Fetch an Annotation resource

GET
https://insights.twilio.com/v1/Voice/{CallSid}/Annotation
パラメーター
Parameters in REST API format
call_sid
Path
GET sid<CA> Not PII

The unique SID identifier of the Call.

例 1
        
        
        

        Update an Annotation resource

        post
        https://insights.twilio.com/v1/Voice/{CallSid}/Annotation
        パラメーター
        Parameters in REST API format
        call_sid
        Path
        post sid<CA> Not PII

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

        answered_by
        オプション
        post ienum:answered_by Not PII

        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
        オプション
        post ienum:connectivity_issue Not PII

        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
        オプション
        post 文字列 Not PII

        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
        オプション
        post boolean Not PII

        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
        オプション
        post integer? Not PII

        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
        オプション
        post 文字列 Not PII

        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
        オプション
        post 文字列 Not PII

        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.

        例 1
              
              
              
              ページを評価:

              ヘルプが必要ですか?

              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.

                    
                    
                    

                    フィードバックくださりありがとうございます!

                    Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    Refer us and get $10 in 3 simple steps!

                    ステップ1

                    Get link

                    Get a free personal referral link here

                    ステップ2:

                    Give $10

                    Your user signs up and upgrade using link

                    ステップ3

                    Get $10

                    1,250 free SMSes
                    OR 1,000 free voice mins
                    OR 12,000 chats
                    OR more