Documentation
Sign inGet started

bird whatsapp list

Usage

Exemplo de código
bird whatsapp list [flags]

Description

List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Pass next_cursor back as starting_after to fetch the next page. Filter by status, contact phone number, bsuid, or tag. Use whatsapp_get for one message's current state.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Exemplo de código
bird whatsapp list
bird whatsapp list | jq -r '.data[].id'
bird whatsapp list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--bsuidFilter by business-scoped user ID (Meta identifier).
--created-afterReturn only resources created at or after this timestamp (inclusive lower bound). Combine with created_before to filter to a time window. RFC 3339 / ISO 8601 with timezone.
--created-beforeReturn only resources created strictly before this timestamp (exclusive upper bound). Combine with created_after to filter to a time window. RFC 3339 / ISO 8601 with timezone.
--phone-numberFilter by contact phone number (E.164 exact match).
--response-schemaPrint the fields this command returns, then exit
--status <v1,v2,…>Filter by status. Repeat the parameter to match any of several statuses.
--tag <v1,v2,…>Filter by tag. Accepts name to match any message carrying that tag name, or name:value to match a specific tag pair (e.g. category:welcome). Repeat the parameter to AND-combine several tag filters.

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
--limit <n>Maximum number of items to return per page.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird whatsapp getGet a WhatsApp message
bird whatsapp list-eventsList events for a WhatsApp message
bird whatsapp sendSend a WhatsApp template message to one recipient.