Skip to main content
POST
Add a number

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Body

application/json
e164
string
required
Example:

"+14155551234"

assistantId
string<uuid>
required

The assistant's uuid, shown on its configure page in the console. Names and slugs are not accepted.

ownership
enum<string>
default:platform
Available options:
platform,
byo-trunk
carrier
enum<string>
Available options:
twilio,
vonage,
exotel,
vobiz
trunkId
string
direction
object
label
string

Response

Added.

id
string
Example:

"num-14155551234"

e164
string
scope
enum<string>
default:tenant

platform marks a Vodex-owned shared caller ID: usable as fromNumberId for outbound calls and batches by every workspace, outbound-only, and read-only — PATCH and DELETE return 403. Distinct from ownership, which says whose carrier trunk the number rides.

Available options:
tenant,
platform
ownership
enum<string>
Available options:
platform,
byo-trunk
carrier
enum<string>
Available options:
twilio,
vonage,
exotel,
vobiz
trunkId
string
region
enum<string>
read-only

The number's MARKET, derived from its prefix on read. Never stored and never sent — the tenant's region decides which cell serves the number (0016 §3). Absent for a prefix in neither market.

Available options:
us,
in
assistantId
string<uuid>

The assistant's uuid, shown on its configure page in the console. Names and slugs are not accepted.

direction
object
label
string
configPublished
boolean