Sign inGet started

bird whatsapp numbers create

Usage

Esempio di codice
bird whatsapp numbers create <number-id> [flags]

Description

Create a WhatsApp number connection
Connect a number the workspace already holds to WhatsApp. Take the number's id from bird numbers list, where a connectable number is a dedicated one (nda_ prefix) that can receive text messages; WhatsApp proves ownership for you, so no verification code is asked for. The number comes back preparing and takes a couple of minutes. Read it back with bird whatsapp numbers get until it reports awaiting_signup, at which point it carries finish_setup_url (a browser flow behind an OAuth screen that a person must complete, and that no operation here can substitute for). failed means it could not be prepared and error says why.
Build the request from the <number_id> argument and flags, a JSON WhatsAppNumberCreate body via --body-file ("-" reads stdin), or both — an inline value 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 3 of "Connect a number you hold to WhatsApp". Previous: bird numbers list. Next: bird whatsapp numbers get.

Examples

Esempio di codice
# print the body shape (no credentials needed)
bird whatsapp numbers create --example

# the body it prints:
Esempio di codice
{
  "data_localization_region": "DE",
  "name": "Sales EU",
  "number_id": "nda_01krdgeqcxet5s7t44vh8rt9mg"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--nameYour workspace's own label for the number while we prepare it, used until you finish connecting it. Leave it out and the number's own phone number stands in. Finishing embedded signup replaces it with the label given there, and renaming the number afterwards sets the one that lasts. This has no bearing on what WhatsApp displays to people the number messages.
--data-localization-regionStore this number's message content at rest in a specific country, given as its two-letter ISO 3166 code. Leave it out to use WhatsApp's default storage. This cannot be changed once the number is connected, so set it now if your organization requires it. Possible values: AU, ID, IN, JP, SG, KR, DE, CH, GB, BR, BH, ZA, AE, CA.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp numbers deleteDelete a WhatsApp number connection
bird whatsapp numbers getGet a WhatsApp number
bird whatsapp numbers listList WhatsApp numbers
bird whatsapp numbers precheckCheck a number against WhatsApp
bird whatsapp numbers updateUpdate a WhatsApp number name