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

     1  # SafeListNumbersApi
     2  
     3  All URIs are relative to *https://verify.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSafelist**](SafeListNumbersApi.md#CreateSafelist) | **Post** /v2/SafeList/Numbers | 
     8  [**DeleteSafelist**](SafeListNumbersApi.md#DeleteSafelist) | **Delete** /v2/SafeList/Numbers/{PhoneNumber} | 
     9  [**FetchSafelist**](SafeListNumbersApi.md#FetchSafelist) | **Get** /v2/SafeList/Numbers/{PhoneNumber} | 
    10  
    11  
    12  
    13  ## CreateSafelist
    14  
    15  > VerifyV2Safelist CreateSafelist(ctx, optional)
    16  
    17  
    18  
    19  Add a new phone number to SafeList.
    20  
    21  ### Path Parameters
    22  
    23  This endpoint does not need any path parameter.
    24  
    25  ### Other Parameters
    26  
    27  Other parameters are passed through a pointer to a CreateSafelistParams struct
    28  
    29  
    30  Name | Type | Description
    31  ------------- | ------------- | -------------
    32  **PhoneNumber** | **string** | The phone number to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
    33  
    34  ### Return type
    35  
    36  [**VerifyV2Safelist**](VerifyV2Safelist.md)
    37  
    38  ### Authorization
    39  
    40  [accountSid_authToken](../README.md#accountSid_authToken)
    41  
    42  ### HTTP request headers
    43  
    44  - **Content-Type**: application/x-www-form-urlencoded
    45  - **Accept**: application/json
    46  
    47  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    48  [[Back to Model list]](../README.md#documentation-for-models)
    49  [[Back to README]](../README.md)
    50  
    51  
    52  ## DeleteSafelist
    53  
    54  > DeleteSafelist(ctx, PhoneNumber)
    55  
    56  
    57  
    58  Remove a phone number from SafeList.
    59  
    60  ### Path Parameters
    61  
    62  
    63  Name | Type | Description
    64  ------------- | ------------- | -------------
    65  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    66  **PhoneNumber** | **string** | The phone number to be removed from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
    67  
    68  ### Other Parameters
    69  
    70  Other parameters are passed through a pointer to a DeleteSafelistParams struct
    71  
    72  
    73  Name | Type | Description
    74  ------------- | ------------- | -------------
    75  
    76  ### Return type
    77  
    78   (empty response body)
    79  
    80  ### Authorization
    81  
    82  [accountSid_authToken](../README.md#accountSid_authToken)
    83  
    84  ### HTTP request headers
    85  
    86  - **Content-Type**: Not defined
    87  - **Accept**: Not defined
    88  
    89  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    90  [[Back to Model list]](../README.md#documentation-for-models)
    91  [[Back to README]](../README.md)
    92  
    93  
    94  ## FetchSafelist
    95  
    96  > VerifyV2Safelist FetchSafelist(ctx, PhoneNumber)
    97  
    98  
    99  
   100  Check if a phone number exists in SafeList.
   101  
   102  ### Path Parameters
   103  
   104  
   105  Name | Type | Description
   106  ------------- | ------------- | -------------
   107  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   108  **PhoneNumber** | **string** | The phone number to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
   109  
   110  ### Other Parameters
   111  
   112  Other parameters are passed through a pointer to a FetchSafelistParams struct
   113  
   114  
   115  Name | Type | Description
   116  ------------- | ------------- | -------------
   117  
   118  ### Return type
   119  
   120  [**VerifyV2Safelist**](VerifyV2Safelist.md)
   121  
   122  ### Authorization
   123  
   124  [accountSid_authToken](../README.md#accountSid_authToken)
   125  
   126  ### HTTP request headers
   127  
   128  - **Content-Type**: Not defined
   129  - **Accept**: application/json
   130  
   131  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   132  [[Back to Model list]](../README.md#documentation-for-models)
   133  [[Back to README]](../README.md)
   134