VOvobiz
Trunks

Create a trunk

Create a new SIP trunk for inbound or outbound calling.

post/api/v1/Account/{auth_id}/trunks

Request

Path parameters

auth_idstring required
Example:MA_XXXXXX

Your account Auth ID

Request body

namestring required

Trunk name.

trunk_direction'inbound' | 'outbound'

Direction of the trunk — inbound or outbound only (a trunk is one direction, not both).

trunk_status'enabled' | 'disabled'

Trunk status — enabled or disabled (note: not active).

secureboolean
trunk_domainstring

SIP domain. Auto-generated as {first8ofUUID}.sip.vobiz.ai if omitted.

transport'udp' | 'tcp' | 'tls'
inbound_destinationstring
descriptionstring
concurrent_calls_limitinteger

Stored on the trunk. The enforced concurrency limit is account-level (account base + channel subscriptions), not this field.

cps_limitinteger

Stored on the trunk. The enforced CPS is account-level, not this field.

credential_uuidstring

Attach an existing SIP credential (username / password / realm) by UUID.

ipacl_uuidstring

Attach an existing IP access-control list (IP-based auth) by UUID.

primary_uri_uuidstring

Primary origination URI UUID.

fallback_uri_uuidstring

Fallback origination URI UUID.

recordingboolean

Enable call recording.

enable_transcriptionboolean

Auto-transcribe recordings when recording=true.

pii_redactionboolean

Redact PII from transcriptions.

pii_entity_typesstring

Comma-separated list of entity types to redact.

webhook_urlstring

Customer webhook for call-admission events (CallInitiated / Hangup). Must be a valid public http/https URL. SSRF-validated — localhost, private (RFC1918), and cloud-metadata (169.254.169.254) URLs are rejected with invalid webhook_url. See Trunk Webhooks.

webhook_method'POST' | 'GET'

HTTP method for the webhook callback.

recording_webhook_enabledboolean

Fire a recording.completed webhook to webhook_url after a recording is saved.

usernamestring

Deprecated — use credential_uuid.

passwordstring

Deprecated — use credential_uuid.

ip_whiteliststring[]

Deprecated — use ipacl_uuid.

Example request

{
  "webhook_url": "https://example.com/vobiz/webhook"
}

Response

Success

trunk_idstring required
account_idstring required
namestring required
trunk_domainstring required
trunk_statusstring required
secureboolean required
trunk_directionstring required
concurrent_calls_limitinteger required
cps_limitinteger required
descriptionstring required
transportstring required
recordingboolean required
enable_transcriptionboolean required
pii_redactionboolean required
webhook_methodstring required
recording_webhook_enabledboolean required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.