provider Api20100401Local GET
/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json @utdk/twilio
/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json - AccountSid path required
- The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.
- string
- CountryCode path required
- 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.
- string
- AreaCode query
- The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
- integer
- Contains query
- Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: `*`, `%`, `+`, `$`. The `*` and `%` meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use `*` to match any single character or `%` to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with `+`. To match the end of the pattern, append the pattern with `$`. These meta-characters can't be adjacent to each other.
- string
- SmsEnabled query
- Whether the phone numbers can receive text messages. Can be: `true` or `false`.
- boolean
- MmsEnabled query
- Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.
- boolean
- VoiceEnabled query
- Whether the phone numbers can receive calls. Can be: `true` or `false`.
- boolean
- ExcludeAllAddressRequired query
- 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`.
- boolean
- ExcludeLocalAddressRequired query
- 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`.
- boolean
- ExcludeForeignAddressRequired query
- 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`.
- boolean
- Beta query
- Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
- boolean
- NearNumber query
- 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.
- string
- NearLatLong query
- Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.
- string
- Distance query
- 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.
- integer
- InPostalCode query
- 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.
- string
- InRegion query
- 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.
- string
- InRateCenter query
- 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.
- string
- InLata query
- 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.
- string
- InLocality query
- Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
- string
- FaxEnabled query
- Whether the phone numbers can receive faxes. Can be: `true` or `false`.
- boolean
- PageSize query
- How many resources to return in each list page. The default is 50, and the maximum is 1000.
- integer
- Page query
- The page index. This value is simply for client state.
- integer
- PageToken query
- The page token. This is provided by the API.
- string
Try it
Authentication
Configure credentials for Twilio - Api
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import twilio from '@utdk/twilio';
await twilio.listavailablephonenumberlocal()