bird voice destinations update

Usage

Code example

bird voice destinations update [flags]

Description

Update enabled Voice destination countries

Enable or disable the countries this workspace may place voice calls to. Only the countries you list change; any country you omit keeps its current setting. Enabling one is what lets a call to it past the destination gate; disabling one refuses every call there, so confirm a disable with the user first. Read bird voice destinations list first for the current settings and whether Bird carries calls to the country at all.

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

Procedure

Step 2 of 2 of "Enable the countries a workspace may call". Previous: bird voice destinations list.

Examples

Code example

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

# the body it prints:

Code example

{
  "destinations": [
    {
      "country_code": "NL",
      "enabled": true
    },
    {
      "country_code": "GB",
      "enabled": false
    }
  ]
}

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
--destination <key=value>	The destination countries to enable or disable. Only the countries listed here change; any country you do not list keeps its current setting. Repeatable, one country_code=enabled per entry. (required; or in --body-file)
--response-schema	Print the fields this command returns, then exit

Name	Description
bird voice destinations list	List Voice destination countries

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Understand the conceptWhat is a voice API?Explore the capabilityVoice Implementation guideVoice overview

Get an implementation brief