Skip to main content
POST
voice.number.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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
number
string
required

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

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

Response

The result

number
string
required

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

Pattern: ^\+[1-9]\d{7,14}$
type
string
required

A telephone number.

Allowed value: "telephone"
inboundEnabled
boolean
required

Whether inbound calls have an attached agent.

outboundEnabled
boolean
required

Whether this number can place outbound calls.

status
enum<string>
required

Number availability.

Available options:
active,
activating,
blocked
name
string

Optional display name.

Maximum string length: 40
assistant
string

Your attached assistant name.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
squad
string

Your attached squad name.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$