Skip to main content
Glama

Update SIP trunk

update_sip_trunk
DestructiveIdempotent

Modify settings on an existing Vobiz SIP trunk: attach credentials or IP ACLs, set outbound routing, adjust limits, enable recording or webhooks, or disable it without deleting.

Instructions

Change settings of an existing Vobiz SIP trunk: only the fields you pass change; trunk_id and trunk_domain never change. Use it to attach authentication (credential_uuid, ipacl_uuid), set outbound routing (primary_uri_uuid, fallback_uri_uuid), adjust limits, turn on recording or the event webhook, or pause a trunk with trunk_status: disabled instead of deleting it. Read current values first with get_sip_trunk; for a new trunk use create_sip_trunk. Returns the updated trunk object with credential fields redacted. An unknown trunk_id raises not_found. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true.

Input Schema

NameRequiredDescriptionDefault
nameNoDisplay name of the trunk, 1-100 characters.
secureNotrue encrypts media with SRTP (Vobiz default false). Signalling encryption is chosen with transport: tls.
confirmYesMust be true, set only after the user explicitly approved: changing this SIP trunk. If your client supports MCP elicitation, the server asks the user to approve directly and this flag is not relied on; otherwise it is your attestation that the user approved.
trunk_idYesSIP trunk UUID: the trunk_id returned by list_sip_trunks, get_sip_trunk or create_sip_trunk.
cps_limitNoMaximum new calls per second (flood protection), 1-100 (Vobiz default 2). Independent of concurrent_calls_limit; the enforced CPS is the account-level limit.
recordingNotrue records every call on the trunk (Vobiz default false). Required for enable_transcription and recording_webhook_enabled to have any effect.
transportNoSIP signalling transport: udp (Vobiz default), tcp or tls (encrypted signalling).
ipacl_uuidNoUUID of an IP ACL entry (id from list_ip_acl_entries or add_ip_acl_entry) so SIP from that address is accepted without a password. May be set together with credential_uuid.
descriptionNoFree-text note on the trunk's purpose, up to 1000 characters.
webhook_urlNoPublic https URL (max 500 characters) that receives CallInitiated and Hangup events for calls on this trunk; private and local hosts are rejected.
trunk_statusNoenabled or disabled. A disabled trunk keeps its configuration, credentials and routing but handles no calls; Vobiz reports the state as active/inactive on the trunk object.
webhook_methodNoHTTP method for webhook_url deliveries: POST (Vobiz default) or GET.
credential_uuidNoUUID of a trunk credential (id from list_trunk_credentials or create_trunk_credential) for SIP digest authentication of this trunk's peer.
trunk_directionNoWhich calls the trunk carries: inbound (to your numbers), outbound (from your PBX) or both.
primary_uri_uuidNoUUID of the origination URI (id from list_origination_uris or create_origination_uri) that outbound calls are sent to first; failover order is primary, then fallback.
fallback_uri_uuidNoUUID of the origination URI tried when the primary one fails.
inbound_destinationNoDestination inbound calls on this trunk are delivered to (inbound trunks), up to 255 characters, in the form your Vobiz trunk setup uses.
enable_transcriptionNotrue transcribes recordings automatically (Vobiz default false); only effective while recording is true.
concurrent_calls_limitNoMaximum simultaneous calls on the trunk, 1-1000 (Vobiz default 10). Stored on the trunk; the enforced concurrency is the account-level limit.
recording_webhook_enabledNotrue also sends a recording.completed event to webhook_url after each recording is saved (Vobiz default false); needs recording true and a webhook_url.

Output Schema

NameRequiredDescriptionDefault
okNoTrue on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`.
trunkNoThe trunk after the change.
updatedNoTrue when the change was applied by this call.
http_statusNoHTTP status Vobiz answered with.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed21 schema fields changedv1.4.2
    • addedInput schema / properties / concurrent_calls_limit / description
      Added value: +"Maximum simultaneous calls on the trunk, 1-1000 (Vobiz default 10). Stored on the trunk; the enforced concurrency is the account-level limit."
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true, set only after the user explicitly approved: changing this SIP trunk."New value: +"Must be true, set only after the user explicitly approved: changing this SIP trunk. If your client supports MCP elicitation, the server asks the user to approve directly and this flag is not relied on; otherwise it is your attestation that the user approved."
    • addedInput schema / properties / cps_limit / description
      Added value: +"Maximum new calls per second (flood protection), 1-100 (Vobiz default 2). Independent of concurrent_calls_limit; the enforced CPS is the account-level limit."
    • addedInput schema / properties / credential_uuid / description
      Added value: +"UUID of a trunk credential (id from list_trunk_credentials or create_trunk_credential) for SIP digest authentication of this trunk's peer."
    • addedInput schema / properties / description / description
      Added value: +"Free-text note on the trunk's purpose, up to 1000 characters."
    • addedInput schema / properties / enable_transcription / description
      Added value: +"true transcribes recordings automatically (Vobiz default false); only effective while recording is true."
    • addedInput schema / properties / fallback_uri_uuid / description
      Added value: +"UUID of the origination URI tried when the primary one fails."
    • addedInput schema / properties / inbound_destination / description
      Added value: +"Destination inbound calls on this trunk are delivered to (inbound trunks), up to 255 characters, in the form your Vobiz trunk setup uses."
    • addedInput schema / properties / ipacl_uuid / description
      Added value: +"UUID of an IP ACL entry (id from list_ip_acl_entries or add_ip_acl_entry) so SIP from that address is accepted without a password. May be set together with credential_uuid."
    • addedInput schema / properties / name / description
      Added value: +"Display name of the trunk, 1-100 characters."
    • changedInput schema / properties / primary_uri_uuid / description
      Previous value: -"Origination URI used first (failover order: primary, then fallback)."New value: +"UUID of the origination URI (id from list_origination_uris or create_origination_uri) that outbound calls are sent to first; failover order is primary, then fallback."
    • addedInput schema / properties / recording / description
      Added value: +"true records every call on the trunk (Vobiz default false). Required for enable_transcription and recording_webhook_enabled to have any effect."
    • addedInput schema / properties / recording_webhook_enabled / description
      Added value: +"true also sends a recording.completed event to webhook_url after each recording is saved (Vobiz default false); needs recording true and a webhook_url."
    • addedInput schema / properties / secure / description
      Added value: +"true encrypts media with SRTP (Vobiz default false). Signalling encryption is chosen with transport: tls."
    • addedInput schema / properties / transport / description
      Added value: +"SIP signalling transport: udp (Vobiz default), tcp or tls (encrypted signalling)."
    • addedInput schema / properties / trunk_direction / description
      Added value: +"Which calls the trunk carries: inbound (to your numbers), outbound (from your PBX) or both."
    • addedInput schema / properties / trunk_id / description
      Added value: +"SIP trunk UUID: the trunk_id returned by list_sip_trunks, get_sip_trunk or create_sip_trunk."
    • addedInput schema / properties / trunk_status / description
      Added value: +"enabled or disabled. A disabled trunk keeps its configuration, credentials and routing but handles no calls; Vobiz reports the state as active/inactive on the trunk object."
    • addedInput schema / properties / webhook_method / description
      Added value: +"HTTP method for webhook_url deliveries: POST (Vobiz default) or GET."
    • changedInput schema / properties / webhook_url / description
      Previous value: -"Receives CallInitiated and Hangup events (public https)."New value: +"Public https URL (max 500 characters) that receives CallInitiated and Hangup events for calls on this trunk; private and local hosts are rejected."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "http_status": {
      +      "description": "HTTP status Vobiz answered with.",
      +      "type": "number"
      +    },
      +    "ok": {
      +      "description": "True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`.",
      +      "type": "boolean"
      +    },
      +    "trunk": {
      +      "additionalProperties": {},
      +      "description": "The trunk after the change.",
      +      "properties": {
      +        "concurrent_calls_limit": {
      +          "description": "Concurrent-call limit stored on the trunk.",
      +          "type": [
      +            "number",
      +            "null"
      +          ]
      +        },
      +        "cps_limit": {
      +          "description": "Calls-per-second limit stored on the trunk.",
      +          "type": [
      +            "number",
      +            "null"
      +          ]
      +        },
      +        "created_at": {
      +          "description": "Creation timestamp.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "credential_uuid": {
      +          "description": "Attached trunk credential UUID, if any.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "description": {
      +          "description": "Free-text description.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "enable_transcription": {
      +          "description": "True when recordings are transcribed.",
      +          "type": [
      +            "boolean",
      +            "null"
      +          ]
      +        },
      +        "fallback_uri_uuid": {
      +          "description": "Fallback origination URI UUID, if any.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "inbound_destination": {
      +          "description": "Inbound call destination configured on the trunk, if any.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "ipacl_uuid": {
      +          "description": "Attached IP ACL entry UUID, if any.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "name": {
      +          "description": "Trunk name.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "pii_redaction": {
      +          "description": "True when PII is redacted from transcripts.",
      +          "type": [
      +            "boolean",
      +            "null"
      +          ]
      +        },
      +        "primary_uri_uuid": {
      +          "description": "Primary origination URI UUID, if any.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "recording": {
      +          "description": "True when calls on the trunk are recorded.",
      +          "type": [
      +            "boolean",
      +            "null"
      +          ]
      +        },
      +        "recording_webhook_enabled": {
      +          "description": "True when recording.completed events are sent to webhook_url.",
      +          "type": [
      +            "boolean",
      +            "null"
      +          ]
      +        },
      +        "secure": {
      +          "description": "True when media is encrypted with SRTP.",
      +          "type": [
      +            "boolean",
      +            "null"
      +          ]
      +        },
      +        "transport": {
      +          "description": "SIP transport: udp, tcp or tls.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "trunk_direction": {
      +          "description": "inbound, outbound or both.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "trunk_domain": {
      +          "description": "Auto-generated SIP domain of the trunk ({trunk_id}.sip.vobiz.ai).",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "trunk_id": {
      +          "description": "Trunk UUID; use it as trunk_id elsewhere.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "trunk_status": {
      +          "description": "Trunk state as Vobiz reports it (e.g. active or inactive).",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "updated_at": {
      +          "description": "Last-change timestamp.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "webhook_method": {
      +          "description": "HTTP method for webhook_url.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "webhook_url": {
      +          "description": "Webhook receiving CallInitiated and Hangup events, if set.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "updated": {
      +      "const": true,
      +      "description": "True when the change was applied by this call.",
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observedv1.1.1

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations (destructiveHint=true, idempotentHint=true), it discloses PATCH scoping, immutable fields, that the response redacts credential fields, that an unknown trunk_id raises not_found, and that the call is gated by VOBIZ_ENABLE_PROVISIONING and confirm: true. This is exactly the mutation context an agent cannot infer from annotations alone.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the critical PATCH constraint in the first sentence, then workflows, then return/error behavior, then gating. It is dense and long, but virtually every clause carries distinct operational information rather than repeating schema fields.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 20-parameter mutation tool with an output schema and annotations, the description covers what an agent needs: mutation scope, prerequisites, alternatives, redaction of the return, error behavior, and the confirm/provisioning gate. Nothing material is left to inference.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds value by grouping the 20 parameters into usage categories (auth, outbound routing, limits, recording, webhook, pause) and highlighting trunk_status: disabled as the pause mechanism, giving semantic intent beyond the field-level docs.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Change settings of an existing Vobiz SIP trunk') and immediately pins the mutation semantics ('only the fields you pass change; trunk_id and trunk_domain never change'). It also distinguishes itself from get_sip_trunk and create_sip_trunk, so an agent can place it without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names alternatives and their conditions: read first with get_sip_trunk, use create_sip_trunk for a new trunk. It further routes intent by enumerating when to use it (attach auth, set routing, adjust limits, turn on recording/webhook, pause via trunk_status: disabled rather than deleting).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools