Skip to main content
POST
Request a phone number

Authorizations

Authorization
string
header
required

Organization key (alk_…) created under Settings; acts for the whole organization

Body

application/json
country
string
required

ISO 3166-1 alpha-2 country code the number is bought in

Required string length: 2
agent_id
string

Owning agent; required for organization keys, implied for agent tokens

Minimum string length: 1
number
string

A specific number from a search; omitted lets the platform pick an SMS-capable local number

Required string length: 8 - 20
area_code
string

Preferred area code when no number is named

Pattern: ^\d{3}$
friendly_name
string
Maximum string length: 64
idempotency_key
string

Repeat a request with the same key to get the same number instead of a second one

Maximum string length: 200

Response

Provisioning

phone_number
object
required