Skip to main content
POST
Create an origination URI
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: The URI must start with the sip: scheme. A port is optional - the default SIP port (5060) is assumed when omitted.
  • sip:sbc.example.com - Host only (default port)
  • sip:provider@sip.example.com:5060 - Host with user and explicit port
  • sip:192.168.1.100:5060 - IP address with port
  • sip:trunk@sip.carrier.net:5061 - Custom port
Invalid Formats:
  • http://sip.example.com - Wrong scheme
  • provider@sip.example.com:5060 - Missing sip: prefix

Request Parameters

weight and transport are set after creation. New URIs default to weight: 10 and an inferred transport. To split traffic across same-priority URIs (load balancing) or change priority later, use Update Origination URI or the Console. The create endpoint accepts only name, sip_uri, and priority.

Response

Returns the complete origination URI object, including the auto-generated id UUID and timestamps.
Response - 201 Created
Field name change between request and response. You send sip_uri and name; the response returns them as uri and description. The weight and transport fields appear on the response with their defaults even though you cannot set them at creation.

Examples

cURL - Primary Origination URI

cURL Request

cURL - Failover URI with Lower Priority

cURL Request

cURL - Load Balancing Configuration

Create two URIs at the same priority, then set their weight with Update Origination URI to split traffic (e.g. 70/30). Both come back with the default weight: 10 (an even split) until you adjust them.
Error Response (400 Bad Request): If SIP URI format is invalid:
Error Response - 400 Bad Request
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
uri
string
required

SIP URI of your inbound destination, for example sip:sbc.example.com.

priority
integer
required

Routing priority. Lower values are tried first.

description
string

Label for the origination URI.

sip_uri
string
deprecated

Not read by the API. The API accepts the request but stores an empty uri. Send uri instead.

name
string
deprecated

Not read by the API. Send description instead.

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