Skip to main content
POST
/
api
/
v1
/
account
/
{auth_id}
/
origination-uris
Create an origination URI
curl --request POST \
  --url https://api.vobiz.ai/api/v1/account/{auth_id}/origination-uris \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": "Primary SBC",
  "sip_uri": "sip:sbc.example.com",
  "priority": 1
}
'
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "uri": "sip:sbc1.example.com",
  "priority": 1,
  "weight": 10,
  "enabled": true,
  "transport": "TCP",
  "description": "Primary SBC",
  "created_at": "2026-03-25T10:00:00Z",
  "updated_at": "2026-03-25T10:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

POST https://api.vobiz.ai/api/v1/account/{auth_id}/origination-uris
Creates a new origination URI (SIP destination) for routing outbound calls from your trunk. The URI must be a valid SIP endpoint in the format sip:user@host:port or sip:host:port.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Valid SIP URI Formats:
  • sip:provider@sip.example.com:5060 - Domain with user
  • sip:192.168.1.100:5060 - IP address
  • sip:trunk@sip.carrier.net:5061 - Custom port
Invalid Formats:
  • http://sip.example.com - Wrong protocol
  • provider@sip.example.com:5060 - Missing sip: prefix
  • sip:example.com - Missing port number

Request Parameters

FieldTypeRequiredDescription
uristringYesSIP URI destination in the format sip:user@host:port or sip:host:port. Must be a valid, reachable SIP endpoint (e.g., sip:provider@sip.example.com:5060).
priorityintegerNoRouting priority (lower = higher priority). Default: 1. Use priority 1 for primary routes and priority 2 for backup/failover routes.
weightintegerNoLoad balancing weight. Default: 10. Higher values receive proportionally more traffic among URIs with the same priority (e.g., weight 20 gets twice the traffic of weight 10).
enabledbooleanNoWhether the URI is active for routing. Default: true. Set to false to temporarily disable without deleting.

Response

Returns the complete origination URI object, including the auto-generated id UUID and timestamps.
Response - 201 Created
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "",
  "uri": "sip:sbc1.example.com:5060",
  "priority": 1,
  "weight": 10,
  "enabled": true,
  "transport": "TCP",
  "description": "",
  "created_at": "2026-05-12T05:11:51.914685Z",
  "updated_at": "2026-05-12T05:11:51.914685Z"
}

Examples

cURL - Primary Origination URI

cURL Request
curl -X POST https://api.vobiz.ai/api/v1/account/{auth_id}/origination-uris \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "uri": "sip:provider@sip.example.com:5060",
    "priority": 1,
    "weight": 10,
    "enabled": true
  }'

cURL - Failover URI with Lower Priority

cURL Request
curl -X POST https://api.vobiz.ai/api/v1/account/{auth_id}/origination-uris \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "uri": "sip:backup@sip-backup.example.com:5060",
    "priority": 2,
    "weight": 10,
    "enabled": true
  }'

cURL - Load Balancing Configuration

Create two URIs with the same priority but different weights for 70/30 traffic split:
curl -X POST https://api.vobiz.ai/api/v1/account/{auth_id}/origination-uris \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "uri": "sip:server1@sip.example.com:5060",
    "priority": 1,
    "weight": 70
  }'
Error Response (400 Bad Request): If SIP URI format is invalid:
Error Response - 400 Bad Request
{
  "error": "Invalid SIP URI format. Expected: sip:user@host:port",
  "code": 400
}
Best Practices:
  • Configure at least 2 origination URIs for redundancy (one primary, one failover)
  • Use priority 1 for primary destinations, priority 2 for backup/failover
  • Adjust weights to distribute load across multiple carriers or servers
  • Test connectivity to each URI before enabling in production

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Body

application/json
name
string
required
sip_uri
string
required
priority
integer
required

Response

Success

id
string
required
account_id
string
required
uri
string
required
priority
integer
required
weight
integer
required
enabled
boolean
required
transport
string
required
description
string
required
created_at
string
required
updated_at
string
required