github.com/twilio/twilio-go@v1.20.1/rest/intelligence/v2/docs/ServicesApi.md (about)

     1  # ServicesApi
     2  
     3  All URIs are relative to *https://intelligence.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateService**](ServicesApi.md#CreateService) | **Post** /v2/Services | 
     8  [**DeleteService**](ServicesApi.md#DeleteService) | **Delete** /v2/Services/{Sid} | 
     9  [**FetchService**](ServicesApi.md#FetchService) | **Get** /v2/Services/{Sid} | 
    10  [**ListService**](ServicesApi.md#ListService) | **Get** /v2/Services | 
    11  [**UpdateService**](ServicesApi.md#UpdateService) | **Post** /v2/Services/{Sid} | 
    12  
    13  
    14  
    15  ## CreateService
    16  
    17  > IntelligenceV2Service CreateService(ctx, optional)
    18  
    19  
    20  
    21  Create a new Service for the given Account
    22  
    23  ### Path Parameters
    24  
    25  This endpoint does not need any path parameter.
    26  
    27  ### Other Parameters
    28  
    29  Other parameters are passed through a pointer to a CreateServiceParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **UniqueName** | **string** | Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
    35  **AutoTranscribe** | **bool** | Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
    36  **DataLogging** | **bool** | Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.
    37  **FriendlyName** | **string** | A human readable description of this resource, up to 64 characters.
    38  **LanguageCode** | **string** | The default language code of the audio.
    39  **AutoRedaction** | **bool** | Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
    40  **MediaRedaction** | **bool** | Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
    41  **WebhookUrl** | **string** | The URL Twilio will request when executing the Webhook.
    42  **WebhookHttpMethod** | **string** | 
    43  
    44  ### Return type
    45  
    46  [**IntelligenceV2Service**](IntelligenceV2Service.md)
    47  
    48  ### Authorization
    49  
    50  [accountSid_authToken](../README.md#accountSid_authToken)
    51  
    52  ### HTTP request headers
    53  
    54  - **Content-Type**: application/x-www-form-urlencoded
    55  - **Accept**: application/json
    56  
    57  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    58  [[Back to Model list]](../README.md#documentation-for-models)
    59  [[Back to README]](../README.md)
    60  
    61  
    62  ## DeleteService
    63  
    64  > DeleteService(ctx, Sid)
    65  
    66  
    67  
    68  Delete a specific Service.
    69  
    70  ### Path Parameters
    71  
    72  
    73  Name | Type | Description
    74  ------------- | ------------- | -------------
    75  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    76  **Sid** | **string** | A 34 character string that uniquely identifies this Service.
    77  
    78  ### Other Parameters
    79  
    80  Other parameters are passed through a pointer to a DeleteServiceParams struct
    81  
    82  
    83  Name | Type | Description
    84  ------------- | ------------- | -------------
    85  
    86  ### Return type
    87  
    88   (empty response body)
    89  
    90  ### Authorization
    91  
    92  [accountSid_authToken](../README.md#accountSid_authToken)
    93  
    94  ### HTTP request headers
    95  
    96  - **Content-Type**: Not defined
    97  - **Accept**: Not defined
    98  
    99  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   100  [[Back to Model list]](../README.md#documentation-for-models)
   101  [[Back to README]](../README.md)
   102  
   103  
   104  ## FetchService
   105  
   106  > IntelligenceV2Service FetchService(ctx, Sid)
   107  
   108  
   109  
   110  Fetch a specific Service.
   111  
   112  ### Path Parameters
   113  
   114  
   115  Name | Type | Description
   116  ------------- | ------------- | -------------
   117  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   118  **Sid** | **string** | A 34 character string that uniquely identifies this Service.
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a FetchServiceParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  
   128  ### Return type
   129  
   130  [**IntelligenceV2Service**](IntelligenceV2Service.md)
   131  
   132  ### Authorization
   133  
   134  [accountSid_authToken](../README.md#accountSid_authToken)
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144  
   145  
   146  ## ListService
   147  
   148  > []IntelligenceV2Service ListService(ctx, optional)
   149  
   150  
   151  
   152  Retrieves a list of all Services for an account.
   153  
   154  ### Path Parameters
   155  
   156  This endpoint does not need any path parameter.
   157  
   158  ### Other Parameters
   159  
   160  Other parameters are passed through a pointer to a ListServiceParams struct
   161  
   162  
   163  Name | Type | Description
   164  ------------- | ------------- | -------------
   165  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   166  **Limit** | **int** | Max number of records to return.
   167  
   168  ### Return type
   169  
   170  [**[]IntelligenceV2Service**](IntelligenceV2Service.md)
   171  
   172  ### Authorization
   173  
   174  [accountSid_authToken](../README.md#accountSid_authToken)
   175  
   176  ### HTTP request headers
   177  
   178  - **Content-Type**: Not defined
   179  - **Accept**: application/json
   180  
   181  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   182  [[Back to Model list]](../README.md#documentation-for-models)
   183  [[Back to README]](../README.md)
   184  
   185  
   186  ## UpdateService
   187  
   188  > IntelligenceV2Service UpdateService(ctx, Sidoptional)
   189  
   190  
   191  
   192  Update a specific Service.
   193  
   194  ### Path Parameters
   195  
   196  
   197  Name | Type | Description
   198  ------------- | ------------- | -------------
   199  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   200  **Sid** | **string** | A 34 character string that uniquely identifies this Service.
   201  
   202  ### Other Parameters
   203  
   204  Other parameters are passed through a pointer to a UpdateServiceParams struct
   205  
   206  
   207  Name | Type | Description
   208  ------------- | ------------- | -------------
   209  **IfMatch** | **string** | The If-Match HTTP request header
   210  **AutoTranscribe** | **bool** | Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
   211  **DataLogging** | **bool** | Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.
   212  **FriendlyName** | **string** | A human readable description of this resource, up to 64 characters.
   213  **LanguageCode** | **string** | The default language code of the audio.
   214  **UniqueName** | **string** | Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
   215  **AutoRedaction** | **bool** | Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
   216  **MediaRedaction** | **bool** | Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
   217  **WebhookUrl** | **string** | The URL Twilio will request when executing the Webhook.
   218  **WebhookHttpMethod** | **string** | 
   219  
   220  ### Return type
   221  
   222  [**IntelligenceV2Service**](IntelligenceV2Service.md)
   223  
   224  ### Authorization
   225  
   226  [accountSid_authToken](../README.md#accountSid_authToken)
   227  
   228  ### HTTP request headers
   229  
   230  - **Content-Type**: application/x-www-form-urlencoded
   231  - **Accept**: application/json
   232  
   233  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   234  [[Back to Model list]](../README.md#documentation-for-models)
   235  [[Back to README]](../README.md)
   236