Search phone numbers
Search available caller IDs before buying, so an operator can choose a specific number. Allowed customer role: agency_admin.
Required API key scope: phone_numbers:read.
Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Query Parameters
Campaign id used to scope the operation to one campaign.
1City, state, province, or country to search near.
1Three-digit area code preference.
200 <= x <= 999Country code for number search.
US, CA Digit sequence the available number should contain.
1Search toll-free inventory instead of local inventory.
Response
Available phone number candidates.
Whether number inventory search is currently available.
true
True when a free-text place could not be resolved.
false
Why the search came back empty, and real places to try instead. Present only when nothing could be offered; an ordinary search omits it.
