`bird whatsapp broadcasts test`

Usage

Exemple de code

bird whatsapp broadcasts test <broadcast-id> [flags]

Description

Send a WhatsApp broadcast's previewed message to one number

Sends a real, charged WhatsApp message. Pass the same --language, --parameters and --contact-id as the preview, and its preview_fingerprint.

Build the request from the <broadcast_id> argument and flags, a JSON WhatsAppBroadcastTestRequest 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 7 of 8 of "Check, test and send a WhatsApp broadcast". Previous: bird whatsapp broadcasts preview. Next: bird whatsapp broadcasts send.

Examples

Exemple de code

# print the body shape (no credentials needed)
bird whatsapp broadcasts test --example

# the body it prints:

Exemple de code

{
  "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
  "preview_fingerprint": "9f2c4e1ab37d58c06e4f1a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f",
  "template": {
    "language": "es"
  },
  "to": "+14155550100"
}

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`	Reuse the same key with the identical request when retrying, so a retry does not send a second test. (required)

Options

Name	Description
`--language`	Override the language: One of the template's languages, such as en-US. Omit it to choose each recipient's language from their phone number's country
`--parameters`	Override the parameters. Template inputs as one JSON object, such as {"promo_code":"FALL25"}; replaces the whole map
`--contact-id`	Contact whose data fills the template; required when it reads contact data
`--response-schema`	Print the fields this command returns, then exit
`--to`	Phone number to send the test to, in E.164 format
`--preview-fingerprint`	preview_fingerprint from the matching preview

Name	Description
`bird whatsapp broadcasts cancel`	Cancel a WhatsApp broadcast
`bird whatsapp broadcasts counts`	Get a WhatsApp broadcast's audience counts
`bird whatsapp broadcasts create`	Create a WhatsApp broadcast
`bird whatsapp broadcasts delete`	Delete a WhatsApp broadcast
`bird whatsapp broadcasts get`	Get a WhatsApp broadcast
`bird whatsapp broadcasts list`	List WhatsApp broadcasts
`bird whatsapp broadcasts list-recipients`	List recipients of a WhatsApp broadcast
`bird whatsapp broadcasts preview`	Render a WhatsApp broadcast's message
`bird whatsapp broadcasts pricing-estimate`	Estimate the cost of a WhatsApp broadcast
`bird whatsapp broadcasts send`	Send a WhatsApp broadcast
`bird whatsapp broadcasts send-quota`	Get the messaging limit for a WhatsApp broadcast
`bird whatsapp broadcasts update`	Update a draft or scheduled WhatsApp broadcast
`bird whatsapp broadcasts validate`	Check whether a WhatsApp broadcast can send

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation

Ressources associées