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

     1  # AccountsAvailablePhoneNumbersTollFreeApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ListAvailablePhoneNumberTollFree**](AccountsAvailablePhoneNumbersTollFreeApi.md#ListAvailablePhoneNumberTollFree) | **Get** /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json | 
     8  
     9  
    10  
    11  ## ListAvailablePhoneNumberTollFree
    12  
    13  > []ApiV2010AvailablePhoneNumberTollFree ListAvailablePhoneNumberTollFree(ctx, CountryCodeoptional)
    14  
    15  
    16  
    17  
    18  
    19  ### Path Parameters
    20  
    21  
    22  Name | Type | Description
    23  ------------- | ------------- | -------------
    24  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    25  **CountryCode** | **string** | The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.
    26  
    27  ### Other Parameters
    28  
    29  Other parameters are passed through a pointer to a ListAvailablePhoneNumberTollFreeParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.
    35  **AreaCode** | **int** | The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
    36  **Contains** | **string** | The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.
    37  **SmsEnabled** | **bool** | Whether the phone numbers can receive text messages. Can be: `true` or `false`.
    38  **MmsEnabled** | **bool** | Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.
    39  **VoiceEnabled** | **bool** | Whether the phone numbers can receive calls. Can be: `true` or `false`.
    40  **ExcludeAllAddressRequired** | **bool** | Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.
    41  **ExcludeLocalAddressRequired** | **bool** | Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.
    42  **ExcludeForeignAddressRequired** | **bool** | Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.
    43  **Beta** | **bool** | Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
    44  **NearNumber** | **string** | Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
    45  **NearLatLong** | **string** | Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.
    46  **Distance** | **int** | The search radius, in miles, for a `near_` query.  Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.
    47  **InPostalCode** | **string** | Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
    48  **InRegion** | **string** | Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
    49  **InRateCenter** | **string** | Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.
    50  **InLata** | **string** | Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.
    51  **InLocality** | **string** | Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
    52  **FaxEnabled** | **bool** | Whether the phone numbers can receive faxes. Can be: `true` or `false`.
    53  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    54  **Limit** | **int** | Max number of records to return.
    55  
    56  ### Return type
    57  
    58  [**[]ApiV2010AvailablePhoneNumberTollFree**](ApiV2010AvailablePhoneNumberTollFree.md)
    59  
    60  ### Authorization
    61  
    62  [accountSid_authToken](../README.md#accountSid_authToken)
    63  
    64  ### HTTP request headers
    65  
    66  - **Content-Type**: Not defined
    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