Sign inGet Started

List reaction events for a WhatsApp message

GET
/v1/whatsapp/messages/{message_id}/reaction-events
for await (const event of bird.whatsapp.reaction.listEvents("wam_01krdgeqcxet5s7t44vh8rt9mg")) {
  console.log(event.id, event.emoji, event.status);
}
Respons200
{
  "data": [
    {
      "id": "war_01krdgeqcxet5s7t44vh8rt9mh",
      "emoji": "🎉",
      "status": "rejected",
      "from": {
        "phone_number": "+13124495569"
      },
      "error": {
        "code": "internal_error",
        "description": "the receiving number is no longer connected",
        "occurred_at": "2026-08-28T19:04:22Z"
      },
      "occurred_at": "2026-08-28T19:04:22Z"
    },
    {
      "id": "war_01krdgeqcxet5s7t44vh8rt9mg",
      "emoji": "👍",
      "status": "received",
      "from": {
        "phone_number": "+14155550100",
        "bsuid": "US.13491208655302741918"
      },
      "occurred_at": "2026-08-28T19:01:10Z"
    }
  ],
  "next_cursor": null,
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiMjAyNi0wOC0yOFQxOTowNDoyMloiLCJpIjoiMDE5ZTFiMDctNWQ5ZC03NjhiLTkzZTgtODRkYzUxOGQyNjkxIn0"
}

Returns the changes made to this message's reactions as a cursor-paginated list, newest first: each emoji placed, each one replaced by a different emoji, and each one taken back. Entries are never edited, so a contact who reacts, changes their mind and then removes it leaves three of them.

One case is missing rather than recorded. A reaction is matched to the message it was placed on through a provider id we keep for 15 days, while WhatsApp accepts a reaction on a message up to 30 days old, so one placed on a message older than that cannot be matched and is recorded nowhere: not here, and not in the message's reactions.

Use this to show who reacted and when, or to find out what became of a reaction that never appeared: a failed or rejected entry carries the reason on error. For what currently stands on the message, read its reactions, which folds this log down to one entry per sender.

Pass the response's next_cursor back as starting_after to fetch the next page.

Reaction events are kept for 30 days, counted from when the message they belong to was accepted rather than from the reaction itself. They therefore go at about the same time as the message, not 30 days after the last reaction on it.

Parameter

message_idstring

ID of the message whose reactions to read, as returned in the id field of the message.

Parameter Kueri

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor 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.

Payload Respons

data
array of object
wajib

Changes to this message's reactions, newest first.

Tampilkan atribut turunan
data.id
string
wajib

ID of this entry, unique within the message's reaction log.

data.emoji
nullable string
wajib

The emoji this entry placed, as WhatsApp sent it and not normalized. Null when the entry took a reaction back rather than placing one. Always present, so null is the removal itself rather than a value we are missing.

data.status
string
wajib

What became of one reaction change:

  • received means the contact placed or removed the reaction and WhatsApp told us about it. Every inbound entry carries this.
  • sent means your reaction reached WhatsApp. Reactions have no delivery or read receipt, so this is as far as an outbound entry gets.
  • failed means WhatsApp refused it. error says why, most often because the contact deleted the message. The grounds we can check for ourselves (a message you sent, one that is itself a reaction, one over 30 days old) are refused when you ask, so they do not reach here.
  • rejected means we refused it before it reached WhatsApp, so nothing was sent. error says why.

Only received and sent entries change what stands on the message, so those are the ones the message's reactions are folded from.

Possible values: received, sent, failed, rejected

data.from
object
wajib

Who made the change. Your business number on a reaction you placed, the contact on one they placed.

Tampilkan atribut turunan
data.error
nullable object

Why the change did not take effect. Always carried by a failed or rejected entry, and never by any other, so a failure always says what went wrong. Absent rather than null on the entries that did take effect. The schema leaves it optional because that is a conditional the generators do not express. code is drawn from the vocabulary a message send shares, less its two billing codes: a reaction is never charged, so neither insufficient_balance nor price_not_found appears here.

Tampilkan atribut turunan
data.occurred_at
string
wajib

When the change was made.

next_cursor
nullable string
wajib

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
wajib

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
wajib

Refresh 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.