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

     1  # SafeListNumbersApi
     2  
     3  All URIs are relative to *https://accounts.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSafelist**](SafeListNumbersApi.md#CreateSafelist) | **Post** /v1/SafeList/Numbers | 
     8  [**DeleteSafelist**](SafeListNumbersApi.md#DeleteSafelist) | **Delete** /v1/SafeList/Numbers | 
     9  [**FetchSafelist**](SafeListNumbersApi.md#FetchSafelist) | **Get** /v1/SafeList/Numbers | 
    10  
    11  
    12  
    13  ## CreateSafelist
    14  
    15  > AccountsV1Safelist 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  [**AccountsV1Safelist**](AccountsV1Safelist.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, optional)
    55  
    56  
    57  
    58  Remove a phone number from SafeList.
    59  
    60  ### Path Parameters
    61  
    62  This endpoint does not need any path parameter.
    63  
    64  ### Other Parameters
    65  
    66  Other parameters are passed through a pointer to a DeleteSafelistParams struct
    67  
    68  
    69  Name | Type | Description
    70  ------------- | ------------- | -------------
    71  **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).
    72  
    73  ### Return type
    74  
    75   (empty response body)
    76  
    77  ### Authorization
    78  
    79  [accountSid_authToken](../README.md#accountSid_authToken)
    80  
    81  ### HTTP request headers
    82  
    83  - **Content-Type**: Not defined
    84  - **Accept**: Not defined
    85  
    86  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    87  [[Back to Model list]](../README.md#documentation-for-models)
    88  [[Back to README]](../README.md)
    89  
    90  
    91  ## FetchSafelist
    92  
    93  > AccountsV1Safelist FetchSafelist(ctx, optional)
    94  
    95  
    96  
    97  Check if a phone number exists in SafeList.
    98  
    99  ### Path Parameters
   100  
   101  This endpoint does not need any path parameter.
   102  
   103  ### Other Parameters
   104  
   105  Other parameters are passed through a pointer to a FetchSafelistParams struct
   106  
   107  
   108  Name | Type | Description
   109  ------------- | ------------- | -------------
   110  **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).
   111  
   112  ### Return type
   113  
   114  [**AccountsV1Safelist**](AccountsV1Safelist.md)
   115  
   116  ### Authorization
   117  
   118  [accountSid_authToken](../README.md#accountSid_authToken)
   119  
   120  ### HTTP request headers
   121  
   122  - **Content-Type**: Not defined
   123  - **Accept**: application/json
   124  
   125  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   126  [[Back to Model list]](../README.md#documentation-for-models)
   127  [[Back to README]](../README.md)
   128