Available Phone Numbers

List of AvailablePhoneNumber resources by country

Changed on

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}

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountry}
  • Auth
    HTTP basic

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

  • 5344c0c93a4cRevision changes
    • info

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

    • info

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

    • info

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

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status

  • dce1bcef69f0Revision changes
    • info

      added the non-success response with the status