API Reference
  1. Phone Numbers

Search available toll-free numbers

post
https://api.emaktalk.com/api/v1/numbers/available/toll_free

Searches for toll-free numbers you can order and saves the results so POST /api/v1/numbers/orders can order one. tollFreePattern both narrows the search and highlights the matching digits in the formatted numbers returned. All fields are optional and shared with the local search, so accepting a filter does not mean the carrier applied it. A key with no billing customer gets results without monthly pricing. Requires an API key with the Admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Three-letter country code to search in.

string

Area code (NPA) to search in.

string

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

string

City to search in. Effectiveness depends on the carrier.

string

State to search in.

string

Rate center to search in.

string

LATA to search in.

string

ZIP code to search in.

number

How many numbers to return.

boolean

Shared search flag; this route always searches toll-free numbers.

string

Region or province to search in.

string

LIR code filter.

string

LIR name filter.

string

Digit pattern to search for. Matching digits are highlighted in the formatted numbers returned.

string

Shared with the local search. This route does not perform the address-to-rate-center lookup.

string

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

Responses
200

Toll-free search results, with matches for tollFreePattern highlighted.

401

Missing or invalid API key.

Updated about 6 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago

Did this page help you?