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

     1  # TollfreeVerificationsApi
     2  
     3  All URIs are relative to *https://messaging.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateTollfreeVerification**](TollfreeVerificationsApi.md#CreateTollfreeVerification) | **Post** /v1/Tollfree/Verifications | 
     8  [**DeleteTollfreeVerification**](TollfreeVerificationsApi.md#DeleteTollfreeVerification) | **Delete** /v1/Tollfree/Verifications/{Sid} | 
     9  [**FetchTollfreeVerification**](TollfreeVerificationsApi.md#FetchTollfreeVerification) | **Get** /v1/Tollfree/Verifications/{Sid} | 
    10  [**ListTollfreeVerification**](TollfreeVerificationsApi.md#ListTollfreeVerification) | **Get** /v1/Tollfree/Verifications | 
    11  [**UpdateTollfreeVerification**](TollfreeVerificationsApi.md#UpdateTollfreeVerification) | **Post** /v1/Tollfree/Verifications/{Sid} | 
    12  
    13  
    14  
    15  ## CreateTollfreeVerification
    16  
    17  > MessagingV1TollfreeVerification CreateTollfreeVerification(ctx, optional)
    18  
    19  
    20  
    21  
    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 CreateTollfreeVerificationParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **BusinessName** | **string** | The name of the business or organization using the Tollfree number.
    35  **BusinessWebsite** | **string** | The website of the business or organization using the Tollfree number.
    36  **NotificationEmail** | **string** | The email address to receive the notification about the verification result. .
    37  **UseCaseCategories** | **[]string** | The category of the use case for the Tollfree Number. List as many are applicable..
    38  **UseCaseSummary** | **string** | Use this to further explain how messaging is used by the business or organization.
    39  **ProductionMessageSample** | **string** | An example of message content, i.e. a sample message.
    40  **OptInImageUrls** | **[]string** | Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
    41  **OptInType** | **string** | 
    42  **MessageVolume** | **string** | Estimate monthly volume of messages from the Tollfree Number.
    43  **TollfreePhoneNumberSid** | **string** | The SID of the Phone Number associated with the Tollfree Verification.
    44  **CustomerProfileSid** | **string** | Customer's Profile Bundle BundleSid.
    45  **BusinessStreetAddress** | **string** | The address of the business or organization using the Tollfree number.
    46  **BusinessStreetAddress2** | **string** | The address of the business or organization using the Tollfree number.
    47  **BusinessCity** | **string** | The city of the business or organization using the Tollfree number.
    48  **BusinessStateProvinceRegion** | **string** | The state/province/region of the business or organization using the Tollfree number.
    49  **BusinessPostalCode** | **string** | The postal code of the business or organization using the Tollfree number.
    50  **BusinessCountry** | **string** | The country of the business or organization using the Tollfree number.
    51  **AdditionalInformation** | **string** | Additional information to be provided for verification.
    52  **BusinessContactFirstName** | **string** | The first name of the contact for the business or organization using the Tollfree number.
    53  **BusinessContactLastName** | **string** | The last name of the contact for the business or organization using the Tollfree number.
    54  **BusinessContactEmail** | **string** | The email address of the contact for the business or organization using the Tollfree number.
    55  **BusinessContactPhone** | **string** | The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
    56  **ExternalReferenceId** | **string** | An optional external reference ID supplied by customer and echoed back on status retrieval.
    57  
    58  ### Return type
    59  
    60  [**MessagingV1TollfreeVerification**](MessagingV1TollfreeVerification.md)
    61  
    62  ### Authorization
    63  
    64  [accountSid_authToken](../README.md#accountSid_authToken)
    65  
    66  ### HTTP request headers
    67  
    68  - **Content-Type**: application/x-www-form-urlencoded
    69  - **Accept**: application/json
    70  
    71  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    72  [[Back to Model list]](../README.md#documentation-for-models)
    73  [[Back to README]](../README.md)
    74  
    75  
    76  ## DeleteTollfreeVerification
    77  
    78  > DeleteTollfreeVerification(ctx, Sid)
    79  
    80  
    81  
    82  
    83  
    84  ### Path Parameters
    85  
    86  
    87  Name | Type | Description
    88  ------------- | ------------- | -------------
    89  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    90  **Sid** | **string** | The unique string to identify Tollfree Verification.
    91  
    92  ### Other Parameters
    93  
    94  Other parameters are passed through a pointer to a DeleteTollfreeVerificationParams struct
    95  
    96  
    97  Name | Type | Description
    98  ------------- | ------------- | -------------
    99  
   100  ### Return type
   101  
   102   (empty response body)
   103  
   104  ### Authorization
   105  
   106  [accountSid_authToken](../README.md#accountSid_authToken)
   107  
   108  ### HTTP request headers
   109  
   110  - **Content-Type**: Not defined
   111  - **Accept**: Not defined
   112  
   113  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   114  [[Back to Model list]](../README.md#documentation-for-models)
   115  [[Back to README]](../README.md)
   116  
   117  
   118  ## FetchTollfreeVerification
   119  
   120  > MessagingV1TollfreeVerification FetchTollfreeVerification(ctx, Sid)
   121  
   122  
   123  
   124  
   125  
   126  ### Path Parameters
   127  
   128  
   129  Name | Type | Description
   130  ------------- | ------------- | -------------
   131  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   132  **Sid** | **string** | The unique string to identify Tollfree Verification.
   133  
   134  ### Other Parameters
   135  
   136  Other parameters are passed through a pointer to a FetchTollfreeVerificationParams struct
   137  
   138  
   139  Name | Type | Description
   140  ------------- | ------------- | -------------
   141  
   142  ### Return type
   143  
   144  [**MessagingV1TollfreeVerification**](MessagingV1TollfreeVerification.md)
   145  
   146  ### Authorization
   147  
   148  [accountSid_authToken](../README.md#accountSid_authToken)
   149  
   150  ### HTTP request headers
   151  
   152  - **Content-Type**: Not defined
   153  - **Accept**: application/json
   154  
   155  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   156  [[Back to Model list]](../README.md#documentation-for-models)
   157  [[Back to README]](../README.md)
   158  
   159  
   160  ## ListTollfreeVerification
   161  
   162  > []MessagingV1TollfreeVerification ListTollfreeVerification(ctx, optional)
   163  
   164  
   165  
   166  
   167  
   168  ### Path Parameters
   169  
   170  This endpoint does not need any path parameter.
   171  
   172  ### Other Parameters
   173  
   174  Other parameters are passed through a pointer to a ListTollfreeVerificationParams struct
   175  
   176  
   177  Name | Type | Description
   178  ------------- | ------------- | -------------
   179  **TollfreePhoneNumberSid** | **string** | The SID of the Phone Number associated with the Tollfree Verification.
   180  **Status** | **string** | The compliance status of the Tollfree Verification record.
   181  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   182  **Limit** | **int** | Max number of records to return.
   183  
   184  ### Return type
   185  
   186  [**[]MessagingV1TollfreeVerification**](MessagingV1TollfreeVerification.md)
   187  
   188  ### Authorization
   189  
   190  [accountSid_authToken](../README.md#accountSid_authToken)
   191  
   192  ### HTTP request headers
   193  
   194  - **Content-Type**: Not defined
   195  - **Accept**: application/json
   196  
   197  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   198  [[Back to Model list]](../README.md#documentation-for-models)
   199  [[Back to README]](../README.md)
   200  
   201  
   202  ## UpdateTollfreeVerification
   203  
   204  > MessagingV1TollfreeVerification UpdateTollfreeVerification(ctx, Sidoptional)
   205  
   206  
   207  
   208  
   209  
   210  ### Path Parameters
   211  
   212  
   213  Name | Type | Description
   214  ------------- | ------------- | -------------
   215  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   216  **Sid** | **string** | The unique string to identify Tollfree Verification.
   217  
   218  ### Other Parameters
   219  
   220  Other parameters are passed through a pointer to a UpdateTollfreeVerificationParams struct
   221  
   222  
   223  Name | Type | Description
   224  ------------- | ------------- | -------------
   225  **BusinessName** | **string** | The name of the business or organization using the Tollfree number.
   226  **BusinessWebsite** | **string** | The website of the business or organization using the Tollfree number.
   227  **NotificationEmail** | **string** | The email address to receive the notification about the verification result. .
   228  **UseCaseCategories** | **[]string** | The category of the use case for the Tollfree Number. List as many are applicable..
   229  **UseCaseSummary** | **string** | Use this to further explain how messaging is used by the business or organization.
   230  **ProductionMessageSample** | **string** | An example of message content, i.e. a sample message.
   231  **OptInImageUrls** | **[]string** | Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
   232  **OptInType** | **string** | 
   233  **MessageVolume** | **string** | Estimate monthly volume of messages from the Tollfree Number.
   234  **BusinessStreetAddress** | **string** | The address of the business or organization using the Tollfree number.
   235  **BusinessStreetAddress2** | **string** | The address of the business or organization using the Tollfree number.
   236  **BusinessCity** | **string** | The city of the business or organization using the Tollfree number.
   237  **BusinessStateProvinceRegion** | **string** | The state/province/region of the business or organization using the Tollfree number.
   238  **BusinessPostalCode** | **string** | The postal code of the business or organization using the Tollfree number.
   239  **BusinessCountry** | **string** | The country of the business or organization using the Tollfree number.
   240  **AdditionalInformation** | **string** | Additional information to be provided for verification.
   241  **BusinessContactFirstName** | **string** | The first name of the contact for the business or organization using the Tollfree number.
   242  **BusinessContactLastName** | **string** | The last name of the contact for the business or organization using the Tollfree number.
   243  **BusinessContactEmail** | **string** | The email address of the contact for the business or organization using the Tollfree number.
   244  **BusinessContactPhone** | **string** | The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
   245  **EditReason** | **string** | Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to 'Website fixed'.
   246  
   247  ### Return type
   248  
   249  [**MessagingV1TollfreeVerification**](MessagingV1TollfreeVerification.md)
   250  
   251  ### Authorization
   252  
   253  [accountSid_authToken](../README.md#accountSid_authToken)
   254  
   255  ### HTTP request headers
   256  
   257  - **Content-Type**: application/x-www-form-urlencoded
   258  - **Accept**: application/json
   259  
   260  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   261  [[Back to Model list]](../README.md#documentation-for-models)
   262  [[Back to README]](../README.md)
   263