Available Phone Numbers

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.

get/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountry}

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Project ID that uniquely identifies the Account to retrieve.

IsoCountrystring required

The ISO country code of the number.

Response

The request has succeeded.

country_codestring required

The ISO country code of the number.

countrystring required

The country the number is from.

uristring required

The URI for the API call.

betaboolean required

New numbers on SignalWire are marked as beta.

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 200

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 400

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 401

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the subresource_uris/allOf[CountrySubresourceUris]/ response property for the status 200

      response-property-unevaluated-properties-added

    • added the non-success response with the status 400

      response-non-success-status-added

    • the response property beta became required for the status 200

      response-property-became-required

    • the response property country became required for the status 200

      response-property-became-required

    • the response property country_code became required for the status 200

      response-property-became-required

    • the response property subresource_uris became required for the status 200

      response-property-became-required

    • the response property subresource_uris/allOf[CountrySubresourceUris]/local became required for the status 200

      response-property-became-required

    • the response property subresource_uris/allOf[CountrySubresourceUris]/toll_free became required for the status 200

      response-property-became-required

    • the response property uri became required for the status 200

      response-property-became-required

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 518ffc8751b714See the full diff
    • removed the optional property countries from the response with the 200 status

      response-optional-property-removed

    • added the optional property beta to the response with the 200 status

      response-optional-property-added

    • added the optional property country to the response with the 200 status

      response-optional-property-added

    • added the optional property country_code to the response with the 200 status

      response-optional-property-added

    • added the optional property subresource_uris to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c88f14db21e242See the full diff
    • added the new path request parameter AccountSid

      new-request-path-parameter

    • added the new path request parameter IsoCountry

      new-request-path-parameter

    • removed the optional property beta from the response with the 200 status

      response-optional-property-removed

    • removed the optional property country from the response with the 200 status

      response-optional-property-removed

    • removed the optional property country_code from the response with the 200 status

      response-optional-property-removed

    • removed the optional property subresource_uris from the response with the 200 status

      response-optional-property-removed

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the optional property countries to the response with the 200 status

      response-optional-property-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog