Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

FieldTypeDescription
trunk_idstring (UUID)Unique identifier for the trunk. Automatically generated upon creation.
account_idstringAccount identifier (auth_id) that owns this trunk.
namestringDescriptive name for the trunk. Required. Maximum 255 characters.
trunk_domainstringAuto-generated SIP domain in the form <uuid>.sip.vobiz.ai.
trunk_statusstringStatus of the trunk. Common values: active, inactive.
securebooleanWhether the trunk uses TLS/SRTP. Default: false.
trunk_directionstringDirection of calls. One of inbound, outbound, both.
concurrent_calls_limitintegerMaximum number of simultaneous calls allowed. Default: 10.
cps_limitintegerCalls-per-second rate limit to prevent flooding. Default: 2.
descriptionstringOptional description with additional context about the trunk’s purpose or configuration.
transportstringSIP transport protocol. One of udp, tcp.
recordingbooleanWhether call recording is enabled on the trunk.
enable_transcriptionbooleanWhether call transcription is enabled.
pii_redactionbooleanWhether PII redaction is applied to transcripts.
webhook_methodstringHTTP method used for trunk webhooks. e.g., POST.
recording_webhook_enabledbooleanWhether the recording webhook is enabled.
credential_uuidstring (UUID)UUID of the credential attached to the trunk (outbound trunks).
primary_uri_uuidstring (UUID)UUID of the primary origination URI (inbound trunks).
inbound_destinationstringDestination for inbound call routing (inbound trunks).
created_atstring (ISO 8601)Timestamp when the trunk was created. Format: YYYY-MM-DDTHH:mm:ssZ (UTC).
updated_atstring (ISO 8601)Timestamp of the last update to the trunk. Format: YYYY-MM-DDTHH:mm:ssZ (UTC).

​
Example

A typical trunk object returned by the API:
Trunk Object
{
  "trunk_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "name": "Acme Production Trunk",
  "trunk_domain": "aabbccdd-1234-5678-90ab-cdef12345678.sip.vobiz.ai",
  "trunk_status": "active",
  "secure": false,
  "trunk_direction": "both",
  "concurrent_calls_limit": 10,
  "cps_limit": 2,
  "description": "",
  "transport": "udp",
  "recording": false,
  "enable_transcription": false,
  "pii_redaction": false,
  "webhook_method": "POST",
  "recording_webhook_enabled": false,
  "created_at": "2026-05-12T05:11:52.054462Z",
  "updated_at": "2026-05-12T05:11:52.054462Z"
}
Rate Limiting: The concurrent_calls_limit and cps_limit protect your trunk from overload and help manage costs.Timestamps: All timestamps are in UTC timezone following ISO 8601 format.