Retrieve All Origination URIs

List all origination URIs associated with a trunk.

This API retrieves all origination URIs configured for a specific trunk. The response includes routing configuration such as priority, weight, and enabled status for each URI. Use pagination parameters to control the number of results returned.

Use Case: List all routing destinations to audit your trunk's outbound call routing configuration, verify failover setup, or analyze load balancing distribution across multiple carriers.

HTTP Request

GEThttps://api.vobiz.ai/api/v1/account/{account_id}/trunks/origination-uris

Authentication Required:

• X-Auth-ID: Your account ID (e.g., {Auth_ID})
• X-Auth-Token: Your account Auth Token
• Content-Type: application/json

Query Parameters

Request Parameters

Name	Type	Description
`limit`	integer	Maximum number of URIs to return per page. Default: 20. Range: 1-100.
`offset`	integer	Number of URIs to skip before starting to return results. Default: 0. Used for pagination.

Response

Returns a paginated list of origination URI objects with metadata about the result set.

Response - 200 OK

{
  "meta": {
    "limit": 20,
    "offset": 0,
    "total_count": 3
  },
  "objects": [
    {
      "id": "e1f2a3b4-c5d6-7890-efab-567890123456",

      "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"
    },
    {
      "id": "f2g3h4i5-j6k7-8901-lmno-678901234567",

      "uri": "sip:backup@sip-backup.example.com:5060",
      "priority": 2,
      "weight": 10,
      "enabled": true,
      "created_at": "2025-01-15T11:00:00Z",
      "updated_at": "2025-01-15T11:00:00Z"
    },
    {
      "id": "g3h4i5j6-k7l8-9012-mnop-789012345678",

      "uri": "sip:secondary@sip.example.com:5060",
      "priority": 1,
      "weight": 20,
      "enabled": true,
      "created_at": "2025-01-15T11:15:00Z",
      "updated_at": "2025-01-15T11:15:00Z"
    }
  ]
}

Example Routing Logic:

• Priority 1 URIs (first and third) handle primary traffic
• Among priority 1, traffic is split 33% to first URI (weight 10) and 67% to third URI (weight 20)
• Priority 2 URI (second) serves as failover if all priority 1 URIs fail

Examples

cURL - List All URIs

cURL Request

curl -X GET https://api.vobiz.ai/api/v1/account/{Auth_ID}/trunks/origination-uris \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

cURL - Paginated Results

cURL Request

curl -X GET "https://api.vobiz.ai/api/v1/account/{Auth_ID}/trunks/origination-uris?limit=10&offset=0" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Pagination:

• Use limit to control page size
• Use offset to skip to a specific page
• Check total_count in meta to determine total URIs
• Calculate total pages: Math.ceil(total_count / limit)

Create Origination URI

Update Origination URI