Skip to main content
PUT
Upsert Inbound Route

Authorizations

Authorization
string
header
required

Enter your Tenant API key (or use SANDBOX_API_KEY)

Body

application/json
did_number
string
required
Example:

"+15550000000"

agent_ws_url
string
required
Example:

"ws://127.0.0.1:8765/agent"

route_id
string
Example:

"route-1"

agent_provider
string

hosted_pipecat for self-hosted WebSocket agents, or vapi_sip, retell_sip, bland_sip, elevenlabs_sip, livekit_sip, generic_sip to dial an imported external agent over SIP while the number stays on our telephony engine.

Example:

"retell_sip"

agent_id
string

Agent id on the provider platform (Vapi assistantId, Retell agent_id, Bland pathway).

Example:

"agent_abc"

account_api_key
string

Tenant credential for the provider platform.

sip_credential_id
string

Trunk credential on the external platform (Vapi byo-sip-trunk credentialId, Bland trunk_id). Falls back to the provider env default.

sip_uri
string

Literal sip: dial destination override (self-hosted SBCs, Retell dial-to-SIP call_id legs).

Example:

"sip:[email protected];transport=tcp"

sip_username
string

Digest username when the external trunk uses user/pass auth.

sip_password
string

Digest password when the external trunk uses user/pass auth.

sip_transport
enum<string>

Pins the SIP transport. Empty uses the provider default (tcp; Bland is always tls).

Available options:
tcp,
tls,
udp
sip_region
string

Provider region override (Vapi us/eu, Bland us/ca/eu/asia).

Example:

"us"

voice_engine
string
Example:

"pipecat"

Response

200

Route created/updated