List of AvailablePhoneNumber resources by country
Returns the available-number search directories for one ISO country, grouped by number type such as Local or Toll-Free. This operation describes search routes; use Search local available phone numbers or the toll-free search to return actual inventory.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.
Learn more about API scopes.
Path parameters
Universal Unique Identifier.
The Project ID that uniquely identifies the Account to retrieve.
The ISO country code of the number.
Response
The request has succeeded.
Example response
{
"country_code": "US",
"country": "United States",
"uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US",
"subresource_uris": {
"local": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local",
"toll_free": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/TollFree"
}
}Changes
Changed in 5 of the 40 revisions of this API.2518
- ○
added 'unevaluatedProperties' constraint to the response body for the status
200response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
400response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
401response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the
subresource_uris/allOf[CountrySubresourceUris]/response property for the status200response-property-unevaluated-properties-added
- ○
- ○
added the non-success response with the status
400response-non-success-status-added
- ○
- ○
the response property
betabecame required for the status200response-property-became-required
- ○
the response property
countrybecame required for the status200response-property-became-required
- ○
the response property
country_codebecame required for the status200response-property-became-required
- ○
the response property
subresource_urisbecame required for the status200response-property-became-required
- ○
the response property
subresource_uris/allOf[CountrySubresourceUris]/localbecame required for the status200response-property-became-required
- ○
the response property
subresource_uris/allOf[CountrySubresourceUris]/toll_freebecame required for the status200response-property-became-required
- ○
the response property
uribecame required for the status200response-property-became-required
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ●
removed the optional property
countriesfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
betato the response with the200statusresponse-optional-property-added
- ○
added the optional property
countryto the response with the200statusresponse-optional-property-added
- ○
added the optional property
country_codeto the response with the200statusresponse-optional-property-added
- ○
added the optional property
subresource_uristo the response with the200statusresponse-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
added the new path request parameter
AccountSidnew-request-path-parameter
- ▲
added the new path request parameter
IsoCountrynew-request-path-parameter
- ●
removed the optional property
betafrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
countryfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
country_codefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
subresource_urisfrom the response with the200statusresponse-optional-property-removed
- ○
added the non-success response with the status
401response-non-success-status-added
- ○
added the optional property
countriesto the response with the200statusresponse-optional-property-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲