The Trunk object represents a SIP trunking connection in your account. A trunk provides the foundation for voice communication by managing authentication, rate limiting, and routing configuration. Each trunk can have multiple credentials, IP access control lists, and origination URIs to support various use cases.
Auto-Generated SIP Domain: When a trunk is created, Vobiz automatically generates a unique SIP domain in the format: trunkId.sip.vobiz.ai. This domain is used for inbound call routing to your trunk.
Attributes
Trunk Attributes
| Parameter | Type | Description |
|---|---|---|
trunk_idoptional | string (UUID) | Unique identifier for the trunk. Automatically generated upon creation. |
auth_idoptional | string | The account identifier that owns this trunk. |
nameoptional | string | A descriptive name for the trunk. Required field. Maximum 255 characters. |
descriptionoptional | string | Optional description providing additional context about the trunk's purpose or configuration. |
concurrent_calls_limitoptional | integer | Maximum number of simultaneous calls allowed on this trunk. Default: 10. |
cps_limitoptional | integer | Calls per second (CPS) rate limit to prevent flooding. Default: 5. |
enabledoptional | boolean | Whether the trunk is active and can handle calls. Default: true. |
created_atoptional | string (ISO 8601) | Timestamp when the trunk was created. Format: YYYY-MM-DDTHH:mm:ssZ (UTC timezone). |
updated_atoptional | string (ISO 8601) | Timestamp of the last update to the trunk. Format: YYYY-MM-DDTHH:mm:ssZ (UTC timezone). |
Example
Trunk Object Response
A typical trunk object as returned by the API:
Trunk Object
{
"trunk_id": "bfab10fb-cb97-488b-9c63-989c32980b0f",
"auth_id": "{Auth_ID}",
"name": "Production Trunk",
"description": "Main production SIP trunk for US East region",
"concurrent_calls_limit": 100,
"cps_limit": 10,
"enabled": true,
"created_at": "2025-01-15T10:30:45Z",
"updated_at": "2025-01-20T14:22:10Z"
}Rate Limiting: The concurrent_calls_limitand cps_limit protect your trunk from overload and help manage costs.
Timestamps: All timestamps are in UTC timezone following ISO 8601 format.