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

     1  # ServicesApi
     2  
     3  All URIs are relative to *https://verify.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  > VerifyV2Service CreateService(ctx, optional)
    18  
    19  
    20  
    21  Create a new Verification Service.
    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  **FriendlyName** | **string** | A descriptive string that you create to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.**
    35  **CodeLength** | **int** | The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.
    36  **LookupEnabled** | **bool** | Whether to perform a lookup with each verification started and return info about the phone number.
    37  **SkipSmsToLandlines** | **bool** | Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.
    38  **DtmfInputRequired** | **bool** | Whether to ask the user to press a number before delivering the verify code in a phone call.
    39  **TtsName** | **string** | The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.
    40  **Psd2Enabled** | **bool** | Whether to pass PSD2 transaction parameters when starting a verification.
    41  **DoNotShareWarningEnabled** | **bool** | Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: `Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code`
    42  **CustomCodeEnabled** | **bool** | Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers.
    43  **PushIncludeDate** | **bool** | Optional configuration for the Push factors. If true, include the date in the Challenge's response. Otherwise, the date is omitted from the response. See [Challenge](https://www.twilio.com/docs/verify/api/challenge) resource’s details parameter for more info. Default: false. **Deprecated** do not use this parameter. This timestamp value is the same one as the one found in `date_created`, please use that one instead.
    44  **PushApnCredentialSid** | **string** | Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
    45  **PushFcmCredentialSid** | **string** | Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
    46  **TotpIssuer** | **string** | Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI. Defaults to the service friendly name if not provided.
    47  **TotpTimeStep** | **int** | Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds
    48  **TotpCodeLength** | **int** | Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6
    49  **TotpSkew** | **int** | Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1
    50  **DefaultTemplateSid** | **string** | The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only.
    51  **WhatsappMsgServiceSid** | **string** | The SID of the Messaging Service containing WhatsApp Sender(s) that Verify will use to send WhatsApp messages to your users.
    52  **WhatsappFrom** | **string** | The number to use as the WhatsApp Sender that Verify will use to send WhatsApp messages to your users.This WhatsApp Sender must be associated with a Messaging Service SID.
    53  **VerifyEventSubscriptionEnabled** | **bool** | Whether to allow verifications from the service to reach the stream-events sinks if configured
    54  
    55  ### Return type
    56  
    57  [**VerifyV2Service**](VerifyV2Service.md)
    58  
    59  ### Authorization
    60  
    61  [accountSid_authToken](../README.md#accountSid_authToken)
    62  
    63  ### HTTP request headers
    64  
    65  - **Content-Type**: application/x-www-form-urlencoded
    66  - **Accept**: application/json
    67  
    68  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    69  [[Back to Model list]](../README.md#documentation-for-models)
    70  [[Back to README]](../README.md)
    71  
    72  
    73  ## DeleteService
    74  
    75  > DeleteService(ctx, Sid)
    76  
    77  
    78  
    79  Delete a specific Verification Service Instance.
    80  
    81  ### Path Parameters
    82  
    83  
    84  Name | Type | Description
    85  ------------- | ------------- | -------------
    86  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    87  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Verification Service resource to delete.
    88  
    89  ### Other Parameters
    90  
    91  Other parameters are passed through a pointer to a DeleteServiceParams struct
    92  
    93  
    94  Name | Type | Description
    95  ------------- | ------------- | -------------
    96  
    97  ### Return type
    98  
    99   (empty response body)
   100  
   101  ### Authorization
   102  
   103  [accountSid_authToken](../README.md#accountSid_authToken)
   104  
   105  ### HTTP request headers
   106  
   107  - **Content-Type**: Not defined
   108  - **Accept**: Not defined
   109  
   110  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   111  [[Back to Model list]](../README.md#documentation-for-models)
   112  [[Back to README]](../README.md)
   113  
   114  
   115  ## FetchService
   116  
   117  > VerifyV2Service FetchService(ctx, Sid)
   118  
   119  
   120  
   121  Fetch specific Verification Service Instance.
   122  
   123  ### Path Parameters
   124  
   125  
   126  Name | Type | Description
   127  ------------- | ------------- | -------------
   128  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   129  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Verification Service resource to fetch.
   130  
   131  ### Other Parameters
   132  
   133  Other parameters are passed through a pointer to a FetchServiceParams struct
   134  
   135  
   136  Name | Type | Description
   137  ------------- | ------------- | -------------
   138  
   139  ### Return type
   140  
   141  [**VerifyV2Service**](VerifyV2Service.md)
   142  
   143  ### Authorization
   144  
   145  [accountSid_authToken](../README.md#accountSid_authToken)
   146  
   147  ### HTTP request headers
   148  
   149  - **Content-Type**: Not defined
   150  - **Accept**: application/json
   151  
   152  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   153  [[Back to Model list]](../README.md#documentation-for-models)
   154  [[Back to README]](../README.md)
   155  
   156  
   157  ## ListService
   158  
   159  > []VerifyV2Service ListService(ctx, optional)
   160  
   161  
   162  
   163  Retrieve a list of all Verification Services for an account.
   164  
   165  ### Path Parameters
   166  
   167  This endpoint does not need any path parameter.
   168  
   169  ### Other Parameters
   170  
   171  Other parameters are passed through a pointer to a ListServiceParams struct
   172  
   173  
   174  Name | Type | Description
   175  ------------- | ------------- | -------------
   176  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   177  **Limit** | **int** | Max number of records to return.
   178  
   179  ### Return type
   180  
   181  [**[]VerifyV2Service**](VerifyV2Service.md)
   182  
   183  ### Authorization
   184  
   185  [accountSid_authToken](../README.md#accountSid_authToken)
   186  
   187  ### HTTP request headers
   188  
   189  - **Content-Type**: Not defined
   190  - **Accept**: application/json
   191  
   192  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   193  [[Back to Model list]](../README.md#documentation-for-models)
   194  [[Back to README]](../README.md)
   195  
   196  
   197  ## UpdateService
   198  
   199  > VerifyV2Service UpdateService(ctx, Sidoptional)
   200  
   201  
   202  
   203  Update a specific Verification Service.
   204  
   205  ### Path Parameters
   206  
   207  
   208  Name | Type | Description
   209  ------------- | ------------- | -------------
   210  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   211  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Service resource to update.
   212  
   213  ### Other Parameters
   214  
   215  Other parameters are passed through a pointer to a UpdateServiceParams struct
   216  
   217  
   218  Name | Type | Description
   219  ------------- | ------------- | -------------
   220  **FriendlyName** | **string** | A descriptive string that you create to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.**
   221  **CodeLength** | **int** | The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.
   222  **LookupEnabled** | **bool** | Whether to perform a lookup with each verification started and return info about the phone number.
   223  **SkipSmsToLandlines** | **bool** | Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.
   224  **DtmfInputRequired** | **bool** | Whether to ask the user to press a number before delivering the verify code in a phone call.
   225  **TtsName** | **string** | The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.
   226  **Psd2Enabled** | **bool** | Whether to pass PSD2 transaction parameters when starting a verification.
   227  **DoNotShareWarningEnabled** | **bool** | Whether to add a privacy warning at the end of an SMS. **Disabled by default and applies only for SMS.**
   228  **CustomCodeEnabled** | **bool** | Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers.
   229  **PushIncludeDate** | **bool** | Optional configuration for the Push factors. If true, include the date in the Challenge's response. Otherwise, the date is omitted from the response. See [Challenge](https://www.twilio.com/docs/verify/api/challenge) resource’s details parameter for more info. Default: false. **Deprecated** do not use this parameter.
   230  **PushApnCredentialSid** | **string** | Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
   231  **PushFcmCredentialSid** | **string** | Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
   232  **TotpIssuer** | **string** | Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI.
   233  **TotpTimeStep** | **int** | Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds
   234  **TotpCodeLength** | **int** | Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6
   235  **TotpSkew** | **int** | Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1
   236  **DefaultTemplateSid** | **string** | The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only.
   237  **WhatsappMsgServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) to associate with the Verification Service.
   238  **WhatsappFrom** | **string** | The WhatsApp number to use as the sender of the verification messages. This number must be associated with the WhatsApp Message Service.
   239  **VerifyEventSubscriptionEnabled** | **bool** | Whether to allow verifications from the service to reach the stream-events sinks if configured
   240  
   241  ### Return type
   242  
   243  [**VerifyV2Service**](VerifyV2Service.md)
   244  
   245  ### Authorization
   246  
   247  [accountSid_authToken](../README.md#accountSid_authToken)
   248  
   249  ### HTTP request headers
   250  
   251  - **Content-Type**: application/x-www-form-urlencoded
   252  - **Accept**: application/json
   253  
   254  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   255  [[Back to Model list]](../README.md#documentation-for-models)
   256  [[Back to README]](../README.md)
   257