Sign inGet Started

bird whatsapp broadcasts list-recipients

Usage

Exemple de code
bird whatsapp broadcasts list-recipients <broadcast-id> [flags]

Description

List each recipient's delivery status, with rejection_reason on a rejected one and message_id to read the message itself. Filter by phone number with to. The list is empty until the broadcast starts sending.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Exemple de code
bird whatsapp broadcasts list-recipients <broadcast-id>
bird whatsapp broadcasts list-recipients <broadcast-id> | jq -r '.data[].recipient'
bird whatsapp broadcasts list-recipients <broadcast-id> --limit 50 --starting-after <cursor>

Options

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
--limit <n>Maximum number of items to return per page. Allowed range: 1 to 100.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Filters

NameDescription
--response-schemaPrint the fields this command returns, then exit
--toReturn only this recipient, a phone number in E.164 format or a business-scoped user ID. It matches at most one row.
NameDescription
bird whatsapp broadcasts cancelCancel a WhatsApp broadcast
bird whatsapp broadcasts countsGet a WhatsApp broadcast's audience counts
bird whatsapp broadcasts createCreate a WhatsApp broadcast
bird whatsapp broadcasts deleteDelete a WhatsApp broadcast
bird whatsapp broadcasts getGet a WhatsApp broadcast
bird whatsapp broadcasts listList WhatsApp broadcasts
bird whatsapp broadcasts previewRender a WhatsApp broadcast's message
bird whatsapp broadcasts pricing-estimateEstimate the cost of a WhatsApp broadcast
bird whatsapp broadcasts sendSend a WhatsApp broadcast
bird whatsapp broadcasts send-quotaGet the messaging limit for a WhatsApp broadcast
bird whatsapp broadcasts testSend a WhatsApp broadcast's previewed message to one number
bird whatsapp broadcasts updateUpdate a draft or scheduled WhatsApp broadcast
bird whatsapp broadcasts validateCheck whether a WhatsApp broadcast can send

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