Sign in
Available Phone Numbers

Find toll-free numbers

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

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

Changed in 5 of the 40 revisions of this API.16539

  • 5344c0c93a4c6See the full diff
    • ○

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

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the available_phone_numbers/items/ response property for the status 200

      response-property-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the available_phone_numbers/items/capabilities/allOf[PhoneNumberCapabilities]/ response property for the status 200

      response-property-unevaluated-properties-added

  • 2e516ba2383f7See the full diff
    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

      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

      response-property-list-of-types-widened

    • ▲

      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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

  • dce1bcef69f02See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 422

      response-non-success-status-added

  • d5fbaaddfa3e6118See the full diff
    • ▲

      the response property available_phone_numbers/items/lata became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property available_phone_numbers/items/latitude became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property available_phone_numbers/items/longitude became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property available_phone_numbers/items/postal_code became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property available_phone_numbers/items/rate_center became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property available_phone_numbers/items/region became nullable for the status 200

      response-property-became-nullable

    • ●

      removed the optional property available_phone_numbers/items/capabilities/allOf[PhoneNumberCapabilities]/fax from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter InLocality

      new-optional-request-parameter

    • ○

      the response property available_phone_numbers became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/beta became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/capabilities became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/capabilities/allOf[PhoneNumberCapabilities]/MMS became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/capabilities/allOf[PhoneNumberCapabilities]/SMS became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/capabilities/allOf[PhoneNumberCapabilities]/voice became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/friendly_name became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/iso_country became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/lata became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/latitude became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/longitude became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/phone_number became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/postal_code became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/rate_center became required for the status 200

      response-property-became-required

    • ○

      the response property available_phone_numbers/items/region became required for the status 200

      response-property-became-required

    • ○

      the response property uri became required for the status 200

      response-property-became-required

    • ○

      added the required property available_phone_numbers/items/locality to the response with the 200 status

      response-required-property-added

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

  • 3c88f14db21e3413See 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

    • ▲

      the available_phone_numbers/items/capabilities response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property available_phone_numbers/items/capabilities/MMS from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property available_phone_numbers/items/capabilities/SMS from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property available_phone_numbers/items/capabilities/fax from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property available_phone_numbers/items/capabilities/voice from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter AreaCode

      new-optional-request-parameter

    • ○

      added the new optional query request parameter Beta

      new-optional-request-parameter

    • ○

      added the new optional query request parameter Contains

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ExcludeAllAddressRequired

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ExcludeForeignAddressRequired

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ExcludeLocalAddressRequired

      new-optional-request-parameter

    • ○

      added the new optional query request parameter FaxEnabled

      new-optional-request-parameter

    • ○

      added the new optional query request parameter InRegion

      new-optional-request-parameter

    • ○

      added the new optional query request parameter MmsEnabled

      new-optional-request-parameter

    • ○

      added the new optional query request parameter SmsEnabled

      new-optional-request-parameter

    • ○

      added the new optional query request parameter VoiceEnabled

      new-optional-request-parameter

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added PhoneNumberCapabilities to the available_phone_numbers/items/capabilities response property allOf list for the response status 200

      response-property-all-of-added

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