Skip to main content
GET
/
api
/
v1
/
Account
/
{auth_id}
/
trunks
/
origination-uris
List origination URIs
curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/origination-uris \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "meta": {
    "limit": 20,
    "offset": 0,
    "total": 3
  },
  "objects": [
    {
      "id": "11223344-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "uri": "sip:sbc1.example.com",
      "priority": 1,
      "weight": 10,
      "enabled": true,
      "transport": "udp",
      "description": "Primary SBC",
      "created_at": "2026-03-25T10:00:00Z",
      "updated_at": "2026-03-25T10:00:00Z"
    },
    {
      "id": "99887766-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "uri": "sip:sbc2.example.com",
      "priority": 2,
      "weight": 10,
      "enabled": true,
      "transport": "tcp",
      "description": "US East SBC",
      "created_at": "2026-03-22T09:00:00Z",
      "updated_at": "2026-03-22T09:00:00Z"
    },
    {
      "id": "55667788-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "uri": "sip:sbc3.example.com",
      "priority": 10,
      "weight": 10,
      "enabled": true,
      "transport": "tls",
      "description": "",
      "created_at": "2026-03-18T14:41:41Z",
      "updated_at": "2026-03-18T14:41:41Z"
    }
  ]
}
GET https://api.vobiz.ai/api/v1/Account/{auth_id}/trunks/origination-uris
Returns 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.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
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.

​
Query Parameters

FieldTypeRequiredDescription
limitintegerNoMaximum number of URIs to return per page. Default: 20. Range: 1–100.
offsetintegerNoNumber of URIs to skip before returning 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": 3
  },
  "objects": [
    {
      "id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "account_id": "",
      "uri": "sip:sbc1.example.com:5060",
      "priority": 1,
      "weight": 10,
      "enabled": true,
      "transport": "udp",
      "description": "",
      "created_at": "2026-05-10T10:45:30Z",
      "updated_at": "2026-05-10T10:45:30Z"
    },
    {
      "id": "bbccddee-2345-6789-01bc-def234567890",
      "account_id": "",
      "uri": "sip:sbc2.example.com:5060",
      "priority": 2,
      "weight": 10,
      "enabled": true,
      "transport": "udp",
      "description": "",
      "created_at": "2026-05-10T11:00:00Z",
      "updated_at": "2026-05-10T11:00:00Z"
    },
    {
      "id": "ccddeeff-3456-789a-12cd-ef3456789012",
      "account_id": "",
      "uri": "sip:sbc1.example.com:5061",
      "priority": 1,
      "weight": 20,
      "enabled": true,
      "transport": "udp",
      "description": "",
      "created_at": "2026-05-10T11:15:00Z",
      "updated_at": "2026-05-10T11: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 in meta to determine total URIs
  • Calculate total pages: Math.ceil(total / limit)

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"

Response

200 - application/json

List of origination URIs

​
meta
object
required
​
objects
object[]
required