Sign inGet Started

List events for a WhatsApp message

GET
/v1/whatsapp/messages/{message_id}/events
const { data } = await bird.whatsapp.listEvents("wa_abc123");
for (const event of data) console.log(event.type, event.occurred_at);
Réponse200
{
  "data": [
    {
      "id": "ev_01kya19f8p2hs5w1y7k4cmqrtv",
      "type": "whatsapp.sent",
      "occurred_at": "2026-09-15T14:03:11Z"
    },
    {
      "id": "ev_01kya19f2m8xqe4v0t6r3bnpcd",
      "type": "whatsapp.delivered",
      "occurred_at": "2026-09-15T14:03:12Z",
      "recipient": {
        "phone_number": "+15550002222",
        "bsuid": "US.AbC1"
      }
    }
  ]
}

Returns a WhatsApp message's lifecycle events in chronological order, one entry per delivery transition (whatsapp.accepted, whatsapp.sent, whatsapp.delivered, whatsapp.read, whatsapp.failed). The timeline is bounded and returned in full, so this list is not paginated; an unknown message ID returns 404. For the message's current state in a single field, use Get a WhatsApp message instead.

Paramètres

message_idstring

ID of the message, as returned in the send response's id field.

Paramètres de requête

typestring

Keep only events of this exact type (for example whatsapp.delivered or whatsapp.failed). Omit for the full timeline.

Possible values (may grow over time): whatsapp.accepted, whatsapp.delivered, whatsapp.failed, whatsapp.read, whatsapp.received, whatsapp.rejected, whatsapp.sent

Contenu de la réponse

data
array of object
obligatoire

Timeline events for this WhatsApp message, in chronological order. The timeline is bounded and returned in full; this list is not paginated.

Afficher les attributs enfants