Purchase a phone number
Starts a phone-number purchase. Poll the returned phone number for status updates. purpose and country cannot be combined.
Authorizations
Bearer token via Authorization header
Headers
Optional request idempotency key.
1 - 128Body
Use included capacity when available, require included capacity without paid fallback (included_only), or start a paid checkout (rent).
included, included_only, rent Optional ISO 3166-1 alpha-2 country code from GET /numbers/phones/countries. Cannot be combined with purpose.
2^[a-z]{2}$"de"
User-defined display label — NFC-normalized, up to 100 GRAPHEMES (not UTF-16 code units; an emoji/flag may span several). Display-only, never used for routing. Also sets the initial billing name at purchase.
"Support line"
Optional purpose from GET /numbers/phones/purposes.
1 - 96"telegram"
Response
Number purchase accepted — poll GET /numbers/phones/{id}