bird voice trunks create

Usage

Ejemplo de código

bird voice trunks create [flags]

Description

Create a SIP trunk

Create a new SIP trunk for the workspace. Returns the Bird-assigned domain to configure in the customer's PBX or SIP client.

Build the request from flags, a JSON VoiceTrunkCreate 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

Ejemplo de código

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

# the body it prints:

Ejemplo de código

{
  "digest_algorithms": ["MD5"],
  "display_name": "Production PBX trunk"
}

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. (required; or in --body-file)
--outbound-enabled	Whether the new trunk may place calls. Omit it to create a trunk that does neither direction yet, and enable the ones you want once you know what the trunk is for. The settings below configure outbound, so send this as true alongside them.
--inbound-enabled	Whether the new trunk may receive calls. Omit it to create a trunk that does neither direction yet. A trunk receives no calls until it also has at least one gateway and at least one number, both added after create.
--digest-algorithms <v1,v2,…>	The Digest hash algorithms to offer, in the order they should be offered. Omit this to use the default of ['SHA-256', 'MD5'], which suits most equipment. Send ['MD5'] for a PBX that only implements MD5 and rejects or ignores a challenge offering SHA-256 first. This can be changed later without re-issuing credentials. 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. Omit it to create the trunk with this off, which is what a trunk reached only by a PBX wants. It can be changed later.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird voice trunks delete	Delete a SIP trunk
bird voice trunks get	Get a SIP trunk
bird voice trunks list	List SIP trunks
bird voice trunks update	Update a SIP trunk