`bird voice settings update`

Usage

Code example

bird voice settings update [flags]

Description

Change the workspace's default inbound route

The default inbound route answers calls for every number without a route of its own, from the next call each receives; a number with its own route keeps it. trunk needs --trunk-id and a trunk with inbound calling enabled, forward needs --forward-to and --forward-as, and sequence needs --sequence-id and --entry-node-id.

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

Code example

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

# the body it prints:

Code example

{
  "inbound_configuration": {
    "route": {
      "trunk_id": "spt_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "trunk"
    }
  }
}

Code example

# deliver calls for every number without its own route to a SIP trunk
bird voice settings update --route trunk --trunk-id spt_456

# refuse them again
bird voice settings update --route reject

Options

Default inbound route

Name	Description
`--route`	What a call arriving for a number without its own route does: reject, trunk, forward, or sequence
`--trunk-id`	With --route trunk: the SIP trunk that answers (spt_…)
`--forward-to`	With --route forward: the verified caller ID to call, in E.164
`--forward-as`	With --route forward: dialed_number or calling_number
`--sequence-id`	With --route sequence: the published sequence to start (vsq_…)
`--entry-node-id`	With --route sequence: the voice-call trigger node to enter

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
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird voice settings get`	Get the voice settings

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources