The Origination URI Object
Complete structure and attributes of an Origination URI object.
The Origination URI object represents a SIP endpoint destination for outbound calls. Each URI specifies where your trunk should route outbound traffic, along with priority and weight settings that control failover behavior and load distribution.
SIP URI Format: Origination URIs must follow the standard SIP URI format:sip:user@host:port orsip:host:port
Examples: sip:provider@sip.example.com:5060,sip:192.168.1.100:5060
Attributes
Origination URI Attributes
| Name | Type | Description |
|---|---|---|
id | string (UUID) | Unique identifier for the origination URI. Automatically generated upon creation. |
trunk_id | string (UUID) | The trunk identifier that owns this origination URI. |
uri | string | The SIP URI destination. Required field. Must follow format: sip:user@host:port or sip:host:port. Examples: sip:provider@sip.example.com:5060, sip:10.0.0.1:5060 |
priority | integer | Routing priority (lower = higher priority). URIs with priority 1 are tried first, then priority 2 as failover. Default: 1. |
weight | integer | Load balancing weight. Used to distribute traffic among URIs with the same priority. Higher values receive more traffic. Default: 10. |
enabled | boolean | Whether the URI is active and can be used for routing calls. Default: true. |
created_at | string (ISO 8601) | Timestamp when the origination URI was created. Format: YYYY-MM-DDTHH:mm:ssZ (UTC timezone). |
updated_at | string (ISO 8601) | Timestamp of the last update to the origination URI. Format: YYYY-MM-DDTHH:mm:ssZ (UTC timezone). |
Example
Origination URI Object Response
A typical origination URI object as returned by the API:
{
"id": "e1f2a3b4-c5d6-7890-efab-567890123456",
"trunk_id": "bfab10fb-cb97-488b-9c63-989c32980b0f",
"uri": "sip:provider@sip.example.com:5060",
"priority": 1,
"weight": 10,
"enabled": true,
"created_at": "2025-01-15T10:45:30Z",
"updated_at": "2025-01-15T10:45:30Z"
}Priority-Based Routing: The system tries URIs in order of priority (lowest number first). If all priority 1 URIs fail, it attempts priority 2, and so on.
Weight-Based Load Balancing: Among URIs with the same priority, traffic is distributed proportionally based on weight. A URI with weight 20 receives twice the traffic of one with weight 10.
Example: With two URIs at priority 1 (weights 10 and 20), the first receives ~33% of traffic and the second receives ~67%.