Available Phone Numbers

Find toll-free numbers

Changed on

Searches SignalWire inventory for toll-free phone numbers available in one ISO country. Results are candidates, not project resources, until purchased through Incoming Phone Numbers or the native purchase operation. Use the local search for local inventory, or native Search phone numbers for the JSON API.

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}/TollFree

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}/TollFree
  • 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.

Query parameters

AreaCodestring

Find numbers in the provided area code. Only available for numbers in US and Canada.

Betaboolean

New numbers on SignalWire are marked as beta.

Containsstring

Find numbers based off of a pattern. Valid characters are [0-9a-zA-Z].

ExcludeAllAddressRequiredboolean

Accepted but has no effect on the response.

ExcludeForeignAddressRequiredboolean

Accepted but has no effect on the response.

ExcludeLocalAddressRequiredboolean

Accepted but has no effect on the response.

FaxEnabledboolean

Accepted but not supported; has no effect on the response.

InLocalitystring

Limits search to a city/locality. Requires InRegion to also be set.

InRegionstring

Limits search to same region as number. Must be a two-letter state/province code.

MmsEnabledboolean

Accepted but not supported; has no effect on the response.

SmsEnabledboolean

Accepted but not supported; has no effect on the response.

VoiceEnabledboolean

Accepted but not supported; has no effect on the response.

Response

The request has succeeded.

uristring required

The URI for the API call.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local",
  "available_phone_numbers": [
    {
      "friendly_name": "(253) 218-6751",
      "phone_number": "+12532186751",
      "rate_center": "AUBURN",
      "region": "WA",
      "iso_country": "US",
      "capabilities": {
        "voice": true,
        "SMS": true,
        "MMS": true
      }
    }
  ]
}

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 body for the status

    • info

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

    • info

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

  • 2e516ba2383fRevision changes
    • breaking

      response property available_phone_numbers/items/lata list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property available_phone_numbers/items/latitude list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property available_phone_numbers/items/locality list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property available_phone_numbers/items/longitude list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property available_phone_numbers/items/postal_code list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property available_phone_numbers/items/rate_center list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property available_phone_numbers/items/region list-of-types was widened by adding types null to media type application/json of response 200