Sign in
Available Phone Numbers

Search for available phone numbers that match your criteria.

Search for Local AvailablePhoneNumbers.

Permissions

The API token must include the following scopes: Numbers.

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

Path parameters

AccountSidstring uuid required

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. Possible values are true or false.

Containsstring

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

ExcludeAllAddressRequiredboolean

Whether or not to exclude numbers that require an address anywhere in the world.

ExcludeForeignAddressRequiredboolean

Whether or not to exclude numbers that require a foreign address.

ExcludeLocalAddressRequiredboolean

Whether or not to exclude numbers that require a local address.

FaxEnabledboolean

Whether or not a number can receive faxes.

InRegionstring

Limits search to same region as number.

MmsEnabledboolean

Whether or not a number can receive MMS messages.

SmsEnabledboolean

Whether or not a number can receive SMS messages.

VoiceEnabledboolean

Whether or not a number can receive calls.

Response

The request has succeeded.

uristring

The URI for the API call.

Example response

{
  "available_phone_numbers": [
    {
      "capabilities": {
        "voice": true,
        "SMS": true,
        "MMS": true,
        "fax": true
      },
      "friendly_name": "253-218-6751",
      "iso_country": "US",
      "lata": "888",
      "latitude": "47.3",
      "longitude": "-122.2",
      "phone_number": "+12532186751",
      "postal_code": "98002",
      "rate_center": "AUBURN",
      "region": "WA"
    }
  ]
}

Changes