Skip to main content
POST
phone.number.purchase

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.

Pattern: ^[A-Z]{2}$
type
enum<string>
required

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free
confirm
boolean
required

Confirm recurring monthly charges; required.

areaCode
string

Area code, one to four digits. A hard constraint when buying.

Pattern: ^\d{1,4}$
phoneNumber
string

Phone number in E.164 format, such as +14155550100.

Pattern: ^\+[1-9]\d{6,14}$
wantsSms
boolean
default:false

Require an SMS-capable number.

connectWhatsapp
boolean
default:false

Also provision WhatsApp; default false.

wantsWhatsapp
boolean
default:false

Ensure WhatsApp eligibility on a standalone purchase.

allowMultiple
boolean
default:false

Confirm an additional purchase within ten minutes.

Response

The result

status
enum<string>
required

Active only after activation is confirmed.

Available options:
active,
verification_required,
pending
country
string
required

Two-letter country code.

Pattern: ^[A-Z]{2}$
type
enum<string>
required

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free
phoneNumber
string

Phone number in E.164 format, such as +14155550100.

Pattern: ^\+[1-9]\d{6,14}$
action
object

Action needed to continue verification.

monthlyPriceUsd
number

What you are charged per month, in US dollars: the price fixed when the number activated, or before that the price quoted when you ordered it.

Required range: x >= 0
ref
string

Reference to what this call created. Pass it as ref to phone.number.purchase-status.