v1

latestSwagger 2.02026-08-06114161439.7 KB
number

Search through the phone number inventory for list of available numbers

Searches available phone numbers from carrier inventory based on area code, prefix, pattern, or geographic location. Returns available numbers that can be reserved and provisioned. Numbers showing null number_id are carrier-available and require reservation before provisioning. See the Knowledge Base article for complete workflow instructions.

get/number/search

Query parameters

npainteger

Area code (first 3 digits of phone number). Example 415.

nxxinteger

Exchange or prefix (digits 4-6 of phone number). Example 555.

ocninteger

Line number (last 4 digits of phone number). Example 1234.

matchstring

Pattern search using underscore as wildcard for any digit. Must be exactly 10 characters. Example 415555____ finds numbers matching 415-555-XXXX. Cannot be combined with other filters.

rcstring

Rate center name to limit search results. Must be used together with state parameter.

statestring

Two-letter state abbreviation. Must be used together with rc parameter. Example CA.

Response

Available phone numbers with carrier information. Null number_id indicates carrier-available numbers requiring reservation.

number_idinteger

The unique identifier for the phone number record

numberinteger required

The full actual phone number

sourceinteger required

Indicator that identifies which source where the number is located