github.com/twilio/twilio-go@v1.20.1/rest/api/v2010/docs/AccountsIncomingPhoneNumbersTollFreeApi.md (about)

     1  # AccountsIncomingPhoneNumbersTollFreeApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateIncomingPhoneNumberTollFree**](AccountsIncomingPhoneNumbersTollFreeApi.md#CreateIncomingPhoneNumberTollFree) | **Post** /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json | 
     8  [**ListIncomingPhoneNumberTollFree**](AccountsIncomingPhoneNumbersTollFreeApi.md#ListIncomingPhoneNumberTollFree) | **Get** /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json | 
     9  
    10  
    11  
    12  ## CreateIncomingPhoneNumberTollFree
    13  
    14  > ApiV2010IncomingPhoneNumberTollFree CreateIncomingPhoneNumberTollFree(ctx, optional)
    15  
    16  
    17  
    18  
    19  
    20  ### Path Parameters
    21  
    22  This endpoint does not need any path parameter.
    23  
    24  ### Other Parameters
    25  
    26  Other parameters are passed through a pointer to a CreateIncomingPhoneNumberTollFreeParams struct
    27  
    28  
    29  Name | Type | Description
    30  ------------- | ------------- | -------------
    31  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.
    32  **PhoneNumber** | **string** | The phone number to purchase specified 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.
    33  **ApiVersion** | **string** | The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.
    34  **FriendlyName** | **string** | A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.
    35  **SmsApplicationSid** | **string** | The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.
    36  **SmsFallbackMethod** | **string** | The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
    37  **SmsFallbackUrl** | **string** | The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.
    38  **SmsMethod** | **string** | The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.
    39  **SmsUrl** | **string** | The URL we should call when the new phone number receives an incoming SMS message.
    40  **StatusCallback** | **string** | The URL we should call using the `status_callback_method` to send status information to your application.
    41  **StatusCallbackMethod** | **string** | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
    42  **VoiceApplicationSid** | **string** | The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
    43  **VoiceCallerIdLookup** | **bool** | Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.
    44  **VoiceFallbackMethod** | **string** | The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
    45  **VoiceFallbackUrl** | **string** | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
    46  **VoiceMethod** | **string** | The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
    47  **VoiceUrl** | **string** | The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.
    48  **IdentitySid** | **string** | The SID of the Identity resource that we should associate with the new phone number. Some regions require an Identity to meet local regulations.
    49  **AddressSid** | **string** | The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
    50  **EmergencyStatus** | **string** | 
    51  **EmergencyAddressSid** | **string** | The SID of the emergency address configuration to use for emergency calling from the new phone number.
    52  **TrunkSid** | **string** | The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
    53  **VoiceReceiveMode** | **string** | 
    54  **BundleSid** | **string** | The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
    55  
    56  ### Return type
    57  
    58  [**ApiV2010IncomingPhoneNumberTollFree**](ApiV2010IncomingPhoneNumberTollFree.md)
    59  
    60  ### Authorization
    61  
    62  [accountSid_authToken](../README.md#accountSid_authToken)
    63  
    64  ### HTTP request headers
    65  
    66  - **Content-Type**: application/x-www-form-urlencoded
    67  - **Accept**: application/json
    68  
    69  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    70  [[Back to Model list]](../README.md#documentation-for-models)
    71  [[Back to README]](../README.md)
    72  
    73  
    74  ## ListIncomingPhoneNumberTollFree
    75  
    76  > []ApiV2010IncomingPhoneNumberTollFree ListIncomingPhoneNumberTollFree(ctx, optional)
    77  
    78  
    79  
    80  
    81  
    82  ### Path Parameters
    83  
    84  This endpoint does not need any path parameter.
    85  
    86  ### Other Parameters
    87  
    88  Other parameters are passed through a pointer to a ListIncomingPhoneNumberTollFreeParams struct
    89  
    90  
    91  Name | Type | Description
    92  ------------- | ------------- | -------------
    93  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.
    94  **Beta** | **bool** | Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
    95  **FriendlyName** | **string** | A string that identifies the resources to read.
    96  **PhoneNumber** | **string** | The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
    97  **Origin** | **string** | Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
    98  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    99  **Limit** | **int** | Max number of records to return.
   100  
   101  ### Return type
   102  
   103  [**[]ApiV2010IncomingPhoneNumberTollFree**](ApiV2010IncomingPhoneNumberTollFree.md)
   104  
   105  ### Authorization
   106  
   107  [accountSid_authToken](../README.md#accountSid_authToken)
   108  
   109  ### HTTP request headers
   110  
   111  - **Content-Type**: Not defined
   112  - **Accept**: application/json
   113  
   114  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   115  [[Back to Model list]](../README.md#documentation-for-models)
   116  [[Back to README]](../README.md)
   117