Sign inGet Started

bird whatsapp agents notifications list

Usage

Code example
bird whatsapp agents notifications list <number-id> [flags]

Description

List the notifications sent to the agent on this WhatsApp number, newest first, each with what came of it, as a cursor page.

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

Examples

Code example
bird whatsapp agents notifications list <number-id>
bird whatsapp agents notifications list <number-id> | jq -r '.data[].id'
bird whatsapp agents notifications list <number-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
--statusReturn only notifications in this state. Possible values: accepted, success, skipped, failed.
--toReturn only notifications about this contact, a phone number in E.164 format or a business-scoped user ID. A phone number is normalized before matching, so spacing does not matter.
NameDescription
bird whatsapp agents notifications createSend an agent a notification
bird whatsapp agents notifications getGet a notification sent to an agent

Continue with the documentation, guides and examples for this topic.