bird voice trunks update

Usage

Exemplo de código

bird voice trunks update <trunk-id> [flags]

Change a SIP trunk's directions, name, access control and Digest offer. A direction has to be enabled before its settings can be set, and one update can do both, so this is the operation that clears VoiceTrunkOutboundNotEnabled and VoiceTrunkInboundNotEnabled. The ip_acls, allowed_api_key_ids and digest_algorithms fields each REPLACE their whole list, so read bird voice trunks get first and send the list you want to end up with; an empty array clears one. Turning inbound_enabled off releases every number the trunk answers and turning it back on does not reclaim them, so confirm that one with the user first.

Build the request from flags, a JSON VoiceTrunkUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Exemplo de código

# print the body shape (no credentials needed)
bird voice trunks update --example

# the body it prints:

Exemplo de código

{
  "allowed_api_key_ids": ["key_01krdgeqcxet5s7t44vh8rt9mg"],
  "digest_algorithms": ["MD5"],
  "display_name": "Production PBX trunk",
  "inbound_enabled": true,
  "ip_acls": [
    {
      "cidr": "203.0.113.0/24",
      "description": "Office network"
    }
  ],
  "outbound_enabled": true,
  "session_credentials_enabled": true
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--display-name	A human-readable label for this SIP trunk. Mutable, and distinct from the generated wire domain.
--outbound-enabled	Whether this trunk may place calls. Turning it off stops the trunk admitting call attempts at the next call setup and leaves its connection and authentication settings stored, so turning it back on restores a working trunk. Omit the field to leave it unchanged.
--inbound-enabled	Whether this trunk may receive calls. Turning it off releases every number this trunk answers: those numbers become available to other trunks, and turning inbound back on does not reclaim them. The gateways are kept. Omit the field to leave it unchanged.
--allowed-api-key-ids <value>…	Replaces the trunk's entire set of allowed API keys. When present, exactly these keys may authenticate the trunk over SIP Digest. Each key you ADD must belong to this workspace and hold voice at write level; a key that does not is refused and the whole update is rolled back. A key already on the list that has since lost the permission or expired does not block the update, so you can keep editing the trunk while you put its permission back. A non-empty list turns API-key authentication on; send an empty array to turn it off. Omit the field to leave the allowed keys unchanged.
--digest-algorithms <v1,v2,…>	Replaces the Digest hash algorithms this trunk offers, in the order they should be offered. Send ['MD5'] for a PBX that only implements MD5 and rejects or ignores a challenge offering SHA-256 first. Send an empty array to return to the default of ['SHA-256', 'MD5']. The offer is never empty, because a trunk that offered nothing could not be authenticated at all. Narrowing the list also narrows what the trunk accepts: an answer using an algorithm no longer offered is rejected. Takes effect on the next call setup; no credential is re-issued. Omit the field to leave the offer unchanged. Possible values: SHA-256, MD5.
--session-credentials-enabled	Whether a session credential may be used to connect to this trunk from a web browser, the CLI or MCP. Off by default; turning it on does not change what the allow lists admit, and turning it off stops those connections at the next call setup without re-issuing anything. Omit the field to leave it unchanged.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird voice trunks create	Create a SIP trunk
bird voice trunks delete	Delete a SIP trunk
bird voice trunks get	Get a SIP trunk
bird voice trunks list	List SIP trunks