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

     1  # ServicesPhoneNumbersApi
     2  
     3  All URIs are relative to *https://proxy.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreatePhoneNumber**](ServicesPhoneNumbersApi.md#CreatePhoneNumber) | **Post** /v1/Services/{ServiceSid}/PhoneNumbers | 
     8  [**DeletePhoneNumber**](ServicesPhoneNumbersApi.md#DeletePhoneNumber) | **Delete** /v1/Services/{ServiceSid}/PhoneNumbers/{Sid} | 
     9  [**FetchPhoneNumber**](ServicesPhoneNumbersApi.md#FetchPhoneNumber) | **Get** /v1/Services/{ServiceSid}/PhoneNumbers/{Sid} | 
    10  [**ListPhoneNumber**](ServicesPhoneNumbersApi.md#ListPhoneNumber) | **Get** /v1/Services/{ServiceSid}/PhoneNumbers | 
    11  [**UpdatePhoneNumber**](ServicesPhoneNumbersApi.md#UpdatePhoneNumber) | **Post** /v1/Services/{ServiceSid}/PhoneNumbers/{Sid} | 
    12  
    13  
    14  
    15  ## CreatePhoneNumber
    16  
    17  > ProxyV1PhoneNumber CreatePhoneNumber(ctx, ServiceSidoptional)
    18  
    19  
    20  
    21  Add a Phone Number to a Service's Proxy Number Pool.
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **ServiceSid** | **string** | The SID parent [Service](https://www.twilio.com/docs/proxy/api/service) resource of the new PhoneNumber resource.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreatePhoneNumberParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **Sid** | **string** | The SID of a Twilio [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the Twilio Number you would like to assign to your Proxy Service.
    39  **PhoneNumber** | **string** | The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.  E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
    40  **IsReserved** | **bool** | Whether the new phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.
    41  
    42  ### Return type
    43  
    44  [**ProxyV1PhoneNumber**](ProxyV1PhoneNumber.md)
    45  
    46  ### Authorization
    47  
    48  [accountSid_authToken](../README.md#accountSid_authToken)
    49  
    50  ### HTTP request headers
    51  
    52  - **Content-Type**: application/x-www-form-urlencoded
    53  - **Accept**: application/json
    54  
    55  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    56  [[Back to Model list]](../README.md#documentation-for-models)
    57  [[Back to README]](../README.md)
    58  
    59  
    60  ## DeletePhoneNumber
    61  
    62  > DeletePhoneNumber(ctx, ServiceSidSid)
    63  
    64  
    65  
    66  Delete a specific Phone Number from a Service.
    67  
    68  ### Path Parameters
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **ServiceSid** | **string** | The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the PhoneNumber resource to delete.
    75  **Sid** | **string** | The Twilio-provided string that uniquely identifies the PhoneNumber resource to delete.
    76  
    77  ### Other Parameters
    78  
    79  Other parameters are passed through a pointer to a DeletePhoneNumberParams struct
    80  
    81  
    82  Name | Type | Description
    83  ------------- | ------------- | -------------
    84  
    85  ### Return type
    86  
    87   (empty response body)
    88  
    89  ### Authorization
    90  
    91  [accountSid_authToken](../README.md#accountSid_authToken)
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: Not defined
    96  - **Accept**: Not defined
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101  
   102  
   103  ## FetchPhoneNumber
   104  
   105  > ProxyV1PhoneNumber FetchPhoneNumber(ctx, ServiceSidSid)
   106  
   107  
   108  
   109  Fetch a specific Phone Number.
   110  
   111  ### Path Parameters
   112  
   113  
   114  Name | Type | Description
   115  ------------- | ------------- | -------------
   116  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   117  **ServiceSid** | **string** | The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the PhoneNumber resource to fetch.
   118  **Sid** | **string** | The Twilio-provided string that uniquely identifies the PhoneNumber resource to fetch.
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a FetchPhoneNumberParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  
   128  ### Return type
   129  
   130  [**ProxyV1PhoneNumber**](ProxyV1PhoneNumber.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  ## ListPhoneNumber
   147  
   148  > []ProxyV1PhoneNumber ListPhoneNumber(ctx, ServiceSidoptional)
   149  
   150  
   151  
   152  Retrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page.
   153  
   154  ### Path Parameters
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   160  **ServiceSid** | **string** | The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the PhoneNumber resources to read.
   161  
   162  ### Other Parameters
   163  
   164  Other parameters are passed through a pointer to a ListPhoneNumberParams struct
   165  
   166  
   167  Name | Type | Description
   168  ------------- | ------------- | -------------
   169  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   170  **Limit** | **int** | Max number of records to return.
   171  
   172  ### Return type
   173  
   174  [**[]ProxyV1PhoneNumber**](ProxyV1PhoneNumber.md)
   175  
   176  ### Authorization
   177  
   178  [accountSid_authToken](../README.md#accountSid_authToken)
   179  
   180  ### HTTP request headers
   181  
   182  - **Content-Type**: Not defined
   183  - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   186  [[Back to Model list]](../README.md#documentation-for-models)
   187  [[Back to README]](../README.md)
   188  
   189  
   190  ## UpdatePhoneNumber
   191  
   192  > ProxyV1PhoneNumber UpdatePhoneNumber(ctx, ServiceSidSidoptional)
   193  
   194  
   195  
   196  Update a specific Proxy Number.
   197  
   198  ### Path Parameters
   199  
   200  
   201  Name | Type | Description
   202  ------------- | ------------- | -------------
   203  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   204  **ServiceSid** | **string** | The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the PhoneNumber resource to update.
   205  **Sid** | **string** | The Twilio-provided string that uniquely identifies the PhoneNumber resource to update.
   206  
   207  ### Other Parameters
   208  
   209  Other parameters are passed through a pointer to a UpdatePhoneNumberParams struct
   210  
   211  
   212  Name | Type | Description
   213  ------------- | ------------- | -------------
   214  **IsReserved** | **bool** | Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.
   215  
   216  ### Return type
   217  
   218  [**ProxyV1PhoneNumber**](ProxyV1PhoneNumber.md)
   219  
   220  ### Authorization
   221  
   222  [accountSid_authToken](../README.md#accountSid_authToken)
   223  
   224  ### HTTP request headers
   225  
   226  - **Content-Type**: application/x-www-form-urlencoded
   227  - **Accept**: application/json
   228  
   229  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   230  [[Back to Model list]](../README.md#documentation-for-models)
   231  [[Back to README]](../README.md)
   232