Search available local numbers

post

https://api.emaktalk.com/api/v1/numbers/available/local

Searches for local numbers you can order and saves the results so POST /api/v1/numbers/orders can order one — a number must come from a search before it can be ordered. Every filter is optional and support for each varies by carrier, so an accepted filter is not proof it was applied; an empty or partial list is normal when a carrier is slow or has no matching inventory. Supplying address searches the rate centers near that address instead of matching one directly. Monthly pricing is attached from billing, and a key with no billing customer gets results without pricing. Requires an API key with the Admin role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

countryCodeA3

string

Three-letter country code to search in. Support varies by carrier.

areaCode

string

Area code (NPA) to search in.

npaNxx

string

Area code and exchange (NPA-NXX) to search in.

city

string

City to search in.

state

string

State to search in.

rateCenter

string

Rate center to search in.

lata

string

LATA to search in.

zip

string

ZIP code to search in.

quantity

number

How many numbers to return. Honored per carrier.

tollFree

boolean

Shared with the toll-free search and has no effect here; this route always searches local numbers.

region

string

Region or province to search in.

lirCode

string

LIR code filter. Support varies by carrier.

lirName

string

LIR name filter. Support varies by carrier.

tollFreePattern

string

Shared with the toll-free search and has no effect on local results.

address

string

A street address to search near. Supplying it finds the rate centers around that address rather than using rateCenter.

customerId

string

Billing customer the results are priced against. Must be one of your account's customers; defaults to the first.

Responses

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Search results. An empty or partial list is possible when a carrier returns nothing.

400The requested billing customer is not one of your account's customers.

403Requires an API key with the Admin role.

500The body was not valid JSON, or the search failed unexpectedly.

503Pricing, the address lookup, or every carrier failed or timed out.