Skip to main content
POST
phone.number.provision

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
country
string
required

Two-letter country code of the number, e.g. US or GB.

Pattern: ^[A-Z]{2}$
areaCode
string

Area code to look in, digits only. Not available in every country.

Pattern: ^\d{2,5}$
type
enum<string>
default:local

Kind of number. Default local. Texts to US numbers need a local number.

Available options:
local,
mobile,
toll_free

Response

The result

phoneNumber
string
required

The new number in E.164 format. Use it as from in sms.send.

country
string
required

Two-letter country code.

type
enum<string>
required

Kind of number.

Available options:
local,
mobile,
toll_free