Get WhatsApp Message History Events
Retrieve paginated message delivery status events for a specific message history entry, including delivery status occurrences, timestamps, and application information.
Use Cases:
- Track detailed message delivery status events and transitions
- Monitor delivery status occurrence timestamps
- Retrieve application information for delivery events
- Debug message delivery issues and status changes
Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.
Caching: Message history events can be cached for short periods, but delivery status events may change frequently. Implement appropriate cache invalidation strategies.
Pagination: This endpoint supports cursor-based pagination. Use the after and before cursors from the response to navigate through results.
Request
- Base URLhttps://graph.facebook.com
- URLhttps://graph.facebook.com/{Version}/{Message-History-ID}/events
- AuthHTTP bearer
Path parameters
Graph API version to use for this request. Determines the API behavior and available features.
Your WhatsApp Business Message History ID. This ID is provided when you retrieve message history and can be found through message history APIs.
Query parameters
Message delivery status
Filter results by specific delivery status. When provided, only events with this delivery status will be returned.
Comma-separated list of fields to include in the response. If not specified, default fields will be returned (cursor, node{id,delivery_status,occurrence_timestamp}). Available fields: cursor, node{id,delivery_status,error_description,occurrence_timestamp,status_timestamp,application}
Maximum number of message history events to return per page. Default is 25, maximum is 100.
Cursor for pagination. Use this to get the next page of results. This value comes from the paging.cursors.after field in previous responses.
Cursor for pagination. Use this to get the previous page of results. This value comes from the paging.cursors.before field in previous responses.
Headers
The user agent string identifying the client software making the request.
Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.
Response
Successfully retrieved WhatsApp message history events
Example response
{
"data": [
{
"cursor": "MTAxNTExOTQ1MjAwNzI5NDE=",
"node": {
"id": "2345678901234567",
"delivery_status": "DELIVERED",
"error_description": "Message delivery failed due to invalid phone number",
"occurrence_timestamp": 1640995200,
"status_timestamp": 1640995205,
"application": {
"id": "9876543210987654",
"name": "Solution Partner App"
}
}
}
],
"paging": {
"cursors": {
"before": "MAZDZD",
"after": "MTAxNTExOTQ1MjAwNzI5NDE="
},
"previous": "https://graph.facebook.com/v23.0/1234567890123456/message_history?before=MAZDZD",
"next": "https://graph.facebook.com/v23.0/1234567890123456/message_history?after=MTAxNTExOTQ1MjAwNzI5NDE="
}
}Changes
No recorded changes to this operation across all 5 revisions of this API.