Import phone number

Import a phone number from custom telephony and bind agents

Authentication

AuthorizationBearer

Clerk JWT token or OrtaVox API key (sk_live_… or pk_live_…)

OR
x-api-keystring

OrtaVox API key (alternative to Bearer token)

Request

This endpoint expects an object.
phone_numberstringRequired
E.164 format phone number
termination_uristringRequired
SIP trunk termination URI
directionenumOptional

Which direction(s) to configure - inbound only, outbound only, or both. Defaults to both if not specified.

Allowed values:
sip_auth_usernamestringOptional

SIP authentication username (required)

sip_auth_passwordstringOptional

SIP authentication password (required)

inbound_agent_idstringOptionalformat: "uuid"
Agent ID for inbound calls
outbound_agent_idstringOptionalformat: "uuid"
Agent ID for outbound calls
inbound_agent_versionintegerOptional
Inbound agent version
outbound_agent_versionintegerOptional
Outbound agent version
nicknamestringOptional
Friendly name for the phone number
inbound_webhook_urlstringOptionalformat: "uri"
Webhook URL for inbound call events

Response

Phone number imported successfully
dataobject or null

Errors