v10

latestSwagger 2.02026-07-13203270.7 KB
Browse for available countries, cities and area codes

Gets the list of cities or towns with available phone numbers.

get/availablePhoneNumbers/countries/{countryCode}/localities

Path parameters

countryCodestring required

The ISO 3166-2 country code, e.g. US.

Query parameters

skipinteger

An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.

maxPageSizeinteger

An optional parameter for how many entries to return, for pagination purposes. The default value is 100.

administrativeDivisionstring

An optional parameter for the name of the state or province in which to search for the area code.

api-versionstring required

Version of API to invoke

phoneNumberType'geographic' | 'tollFree' | 'mobile'

Filter by numberType, e.g. Geographic, TollFree, Mobile.

Headers

accept-languagestring

The locale to display in the localized fields in the response. e.g. 'en-US'

Response

Success

nextLinkstring

Represents the URL link to the next page.