For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
      • GETList of AvailablePhoneNumber resources
      • GETList of AvailablePhoneNumber resources by country
      • GETSearch for available phone numbers that match your criteria.
      • GETFind toll-free numbers
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIAvailable Phone Numbers

Search for available phone numbers that match your criteria.

|View as Markdown|Open in Claude|
GET
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:AccountSid/AvailablePhoneNumbers/:IsoCountry/Local
GET
/api/laml/2010-04-01/Accounts/:AccountSid/AvailablePhoneNumbers/:IsoCountry/Local
$curl https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/AvailablePhoneNumbers/IsoCountry/Local \
>     -u "<project_id>:<api_token>"
1{
2  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local",
3  "available_phone_numbers": [
4    {
5      "friendly_name": "(253) 218-6751",
6      "phone_number": "+12532186751",
7      "lata": null,
8      "locality": null,
9      "rate_center": "AUBURN",
10      "latitude": null,
11      "longitude": null,
12      "region": "WA",
13      "postal_code": null,
14      "iso_country": "US",
15      "capabilities": {
16        "voice": true,
17        "SMS": true,
18        "MMS": true
19      },
20      "beta": false
21    }
22  ]
23}

Search for Local AvailablePhoneNumbers.

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.

Was this page helpful?
Previous

Find toll-free numbers

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account to retrieve.
IsoCountrystringRequired
The ISO country code of the number.

Query parameters

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

New numbers on SignalWire are marked as beta.

ContainsstringOptional

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

ExcludeAllAddressRequiredbooleanOptional
Accepted for Twilio compatibility but has no effect on the response.
ExcludeForeignAddressRequiredbooleanOptional
Accepted for Twilio compatibility but has no effect on the response.
ExcludeLocalAddressRequiredbooleanOptional
Accepted for Twilio compatibility but has no effect on the response.
FaxEnabledbooleanOptional
Not supported. Accepted for Twilio API compatibility.
InLocalitystringOptional

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

InRegionstringOptional

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

MmsEnabledbooleanOptional
Not supported. Accepted for Twilio API compatibility.
SmsEnabledbooleanOptional
Not supported. Accepted for Twilio API compatibility.
VoiceEnabledbooleanOptional
Not supported. Accepted for Twilio API compatibility.

Response

The request has succeeded.
uristring
The URI for the API call.
available_phone_numberslist of objects
List of available phone numbers.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)