Sign inGet Started

bird whatsapp

Usage

Codebeispiel
bird whatsapp

Description

A preview link opens a service-message payload in the public builder without signing in. Sends carry exactly one content kind; delivery is asynchronous. The template registry, business accounts, and stats are read-only.

Reads return JSON; list is paginated. Mutations take flags and/or a --body-file JSON body (flags overriding); run --example to print the body shape or --dry-run to preview the request.

Messages

NameDescription
previewPreview a WhatsApp message in the public builder
sendSend a WhatsApp message to one recipient or one group
getGet a WhatsApp message
listList WhatsApp messages
list-eventsList events for a WhatsApp message
mark-readMark a WhatsApp message as read
reactionPlace, take back, and follow the emoji reactions on a received message
mediaDownload a received WhatsApp message's media

Templates

NameDescription
templatesBrowse the WhatsApp templates available to the workspace

Broadcasts

NameDescription
broadcastsSend one approved template to a stored audience

Groups

NameDescription
groupsCreate and administer WhatsApp groups

Conversations

NameDescription
conversationsRead, assign, label and resolve WhatsApp conversations

Agents

NameDescription
agentsRun the WhatsApp Business Agent that answers contacts on a number

Senders

NameDescription
numbersConnect, read, and disconnect the numbers the workspace sends WhatsApp messages from
business-accountsRead the WhatsApp Business Accounts the workspace has connected

Compliance

NameDescription
suppressionsManage the addresses the workspace will not message on WhatsApp
keyword-rulesConfigure what a reply to one of the workspace's numbers does

Analytics

NameDescription
statsRead aggregate WhatsApp statistics