Search for available phone numbers that match your criteria.
Searches SignalWire inventory for local 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 toll-free search for toll-free 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.
Path parameters
Universal Unique Identifier.
The Project ID that uniquely identifies the Account to retrieve.
The ISO country code of the number.
Query parameters
Find numbers in the provided area code. Only available for numbers in US and Canada.
New numbers on SignalWire are marked as beta.
Find numbers based off of a pattern. Valid characters are [0-9a-zA-Z].
Accepted but has no effect on the response.
Accepted but has no effect on the response.
Accepted but has no effect on the response.
Accepted but not supported; has no effect on the response.
Limits search to a city/locality. Requires InRegion to also be set.
Limits search to same region as number. Must be a two-letter state/province code.
Accepted but not supported; has no effect on the response.
Accepted but not supported; has no effect on the response.
Accepted but not supported; has no effect on the response.
Response
The request has succeeded.
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
}
}
]
}