Number Order API

Overview

Order phone numbers with KYC compliance through a guided multi-step workflow. Required in countries where number purchases need identity verification.

Agent Instructions

Before generating code, gather from the user (skip any item already specified in the prompt or context):

1. Country — ISO 3166-1 alpha-2 region code (e.g. AU, DE, BR).
2. Number type — MOBILE, LOCAL, or TOLL_FREE.
3. Specific number or quantity? — E.164 phone number, or quantity + criteria.
4. SMS or Voice? — SMS needs servicePlanId (+ campaignId for US 10DLC). Voice needs type (RTC/EST/FAX) + corresponding ID (appId/trunkId/serviceId).
5. Language — any language, or curl. This API is REST-only; there is no SDK wrapper.

This is a sequential, fragile workflow — steps must be followed in order. Do not combine API calls. Step 2 may be skipped if the user already has a specific E.164 number.

Refer to the API reference linked in Links for request/response schemas.