Search available numbers
num_searchSearch upstream inventory for purchasable phone numbers by area code, rate center, locality, or digit pattern. Returns paginated candidates you do not yet own, ready for ordering.
Instructions
Search upstream inventory for PURCHASABLE telephone numbers by area code, rate center, locality, or digit pattern. Returns paginated candidates you do not yet own. Use this before ordering; then buy a candidate with num_order (or many with num_bulk_order). For numbers you already own use num_list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| npa | No | Area code (NPA), 3 digits, e.g. "303" | |
| nxx | No | Exchange (NXX), 3 digits, e.g. "629" | |
| city | No | City name | |
| page | No | Page number, 1-based (default 1) | |
| size | No | Results per page (default 25) | |
| type | No | Number type: "did" (local, default) or "tfn" (toll-free) | |
| state | No | 2-letter state code, e.g. "CO" | |
| pattern | No | Digit pattern to match within the number, e.g. "1234" | |
| locality | No | Locality name | |
| rate_center | No | LERG rate center name, e.g. "DENVER" | |
| last_4_prefix | No | Prefix the last 4 digits must start with |