List the notifications sent to an agent
/v1/whatsapp/numbers/{number_id}/agent/notificationsconst notifications = await bird.whatsapp.agents.notifications.list("wan_01krdgeqcxet5s7t44vh8rt9mg", {
status: "skipped",
});
for (const notification of notifications.data ?? []) {
console.log(notification.name, notification.skipped_reason);
}notifications = client.whatsapp.agents.notifications.list("wan_01krdgeqcxet5s7t44vh8rt9mg", status="skipped")
for notification in notifications.data or []:
print(notification.name, notification.skipped_reason)for notification, err := range client.Whatsapp.Agents.Notifications.List(context.Background(), "wan_01krdgeqcxet5s7t44vh8rt9mg", bird.WhatsappAgentsNotificationsListParams{
Status: bird.WhatsAppAgentNotificationStatusSkipped,
}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(*notification.Name, *notification.SkippedReason) // skipped always carries a reason
}foreach ($bird->whatsapp->agents->notifications->list('wan_01krdgeqcxet5s7t44vh8rt9mg', ['status' => 'skipped']) as $notification) {
echo $notification->getName(), ' ', $notification->getSkippedReason(), PHP_EOL;
}bird whatsapp agents notifications list <number-id>curl -X GET "https://us1.platform.bird.com/v1/whatsapp/numbers/{number_id}/agent/notifications" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"{
"data": [
{
"id": "waan_01krdgeqcxet5s7t44vh8rt9m7",
"to": {
"phone_number": "+14155551234"
},
"name": "order_shipped",
"description": "Order 88213 left the warehouse and arrives on Thursday.",
"payload": "{\"order_id\":\"88213\",\"carrier\":\"ACME Courier\",\"eta\":\"2026-10-02\"}",
"status": "skipped",
"skipped_reason": "The contact's conversation is currently held by the business.",
"created_at": "2026-10-01T08:00:00Z"
},
{
"id": "waan_01krdgeqcxet5s7t44vh8rt9m6",
"to": {
"phone_number": "+14155559876"
},
"name": "payment_received",
"description": "Payment of $42.00 for order 88190 was received.",
"payload": "{\"order_id\":\"88190\",\"amount\":\"42.00\",\"currency\":\"USD\"}",
"status": "success",
"created_at": "2026-10-01T07:30:00Z"
}
],
"next_cursor": null,
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTEwLTAxVDA4OjAwOjAwWlwiIiwiaSI6IndhYW5fMDFrcmRnZXFjeGV0NXM3dDQ0dmg4cnQ5bTcifQ"
}
Returns the notifications you have sent the agent, newest first, each with what came of it. Filter by status to find the ones the agent skipped or WhatsApp refused, or by to to follow one contact. A notification still in flight to WhatsApp is not listed yet.
A number without an agent returns 404. Page through the full set with the response cursors.
参数
number_idstringID of the WhatsApp number (wan_ prefix), as returned by the number list.
查询参数
statusstringReturn only notifications in this state.
Possible values: accepted, success, skipped, failed
tostringReturn 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.
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor 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.
响应载荷
dataA page of the notifications sent to the agent.
显示子属性
data.idUnique identifier for the notification.
data.toThe contact the notification was about: the phone number or business-scoped user ID you addressed it to, in the same shape a message's to uses.
显示子属性
data.to.phone_numberPhone number in E.164 format, when known.
data.to.bsuidBusiness-scoped user ID, Meta's identifier for the WhatsApp user. Present only on the WhatsApp-user side of the message.
data.to.group_idThe group this address was addressed as, or reached through. It appears on a message's to and nowhere else: never on from, and never on an event's recipient. Outbound, it stands in for the recipient, because a group send names no single phone number. Inbound, it qualifies one: to carries the business phone_number that received the message and the group it arrived through, while from stays the participant who wrote it. Its presence on to is what tells a group message from a one-to-one one, in either direction.
data.to.usernamePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the contact has not adopted one, and on a message received before this workspace started recording them. Same form as a number's own username (WhatsAppNumberProfile.username), without a leading @; a message cannot be addressed by it.
data.to.display_namePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the message carries no profile, and on a message received before this workspace started recording them.
data.nameYour own name for what happened, as you sent it.
data.descriptionWhat happened, as you sent it.
data.payloadThe data you attached, as you sent it.
data.statusWhere the notification stands. accepted from the moment Bird takes it, then one of the three final states once WhatsApp has answered.
data.skipped_reasonWhatsApp's own account of why the agent chose to say nothing, passed through. Present only when status is skipped. Show it to the person who sent the notification; never match on its text.
data.errorWhy the notification failed. Present only when status is failed.
显示子属性
data.error.descriptionWhatsApp's own explanation, passed through: what it said when it refused the notification, or its failure summary once it had worked on it. Show it to the person who sent the notification; never match on its text. Carries Bird's own words instead when the failure was Bird's verdict, such as no outcome arriving within a day.
data.error.meta_error_codeWhatsApp's most specific code when it refused the notification outright: its error subcode where it sent one, otherwise its top-level code. Treat it as an opaque string. Null when WhatsApp took the notification and reported the failure later, which carries no code, and when the failure was Bird's own verdict.
data.created_atWhen Bird accepted the notification.
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.