github.com/twilio/twilio-go@v1.20.1/rest/insights/v1/docs/VoiceAnnotationApi.md (about)

     1  # VoiceAnnotationApi
     2  
     3  All URIs are relative to *https://insights.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchAnnotation**](VoiceAnnotationApi.md#FetchAnnotation) | **Get** /v1/Voice/{CallSid}/Annotation | 
     8  [**UpdateAnnotation**](VoiceAnnotationApi.md#UpdateAnnotation) | **Post** /v1/Voice/{CallSid}/Annotation | 
     9  
    10  
    11  
    12  ## FetchAnnotation
    13  
    14  > InsightsV1Annotation FetchAnnotation(ctx, CallSid)
    15  
    16  
    17  
    18  Get the Annotation for a specific Call.
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **CallSid** | **string** | The unique SID identifier of the Call.
    27  
    28  ### Other Parameters
    29  
    30  Other parameters are passed through a pointer to a FetchAnnotationParams struct
    31  
    32  
    33  Name | Type | Description
    34  ------------- | ------------- | -------------
    35  
    36  ### Return type
    37  
    38  [**InsightsV1Annotation**](InsightsV1Annotation.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: Not defined
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## UpdateAnnotation
    55  
    56  > InsightsV1Annotation UpdateAnnotation(ctx, CallSidoptional)
    57  
    58  
    59  
    60  Update an Annotation for a specific Call.
    61  
    62  ### Path Parameters
    63  
    64  
    65  Name | Type | Description
    66  ------------- | ------------- | -------------
    67  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    68  **CallSid** | **string** | The unique string that Twilio created to identify this Call resource. It always starts with a CA.
    69  
    70  ### Other Parameters
    71  
    72  Other parameters are passed through a pointer to a UpdateAnnotationParams struct
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  **AnsweredBy** | **string** | 
    78  **ConnectivityIssue** | **string** | 
    79  **QualityIssues** | **string** | 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.
    80  **Spam** | **bool** | 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.
    81  **CallScore** | **int** | 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].
    82  **Comment** | **string** | 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 the `comment`.
    83  **Incident** | **string** | 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 in `incident`.
    84  
    85  ### Return type
    86  
    87  [**InsightsV1Annotation**](InsightsV1Annotation.md)
    88  
    89  ### Authorization
    90  
    91  [accountSid_authToken](../README.md#accountSid_authToken)
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: application/x-www-form-urlencoded
    96  - **Accept**: application/json
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101