Message interactions
You can list message interactions on a specific message using the following endpoint. In order to get a WhatsApp message, you must have an active WhatsApp channel and perform a HTTP request with a valid access key
List message interactions
The ID of the workspace
The ID for a message
The ID for a channel
GET /workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"messageId": "123e4567-e89b-12d3-a456-426614174000",
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"platformId": "text",
"type": "clicked",
"messageReference": "text",
"messagePartsCount": 1,
"messageTags": [
"text"
],
"receiver": {
"connector": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"identifierValue": "text",
"annotations": {
"name": "text"
},
"types": [
"text"
]
}
},
"createdAt": "2025-07-01T22:50:53.285Z",
"details": "text",
"context": {
"id": "text",
"type": "text",
"tags": [
"text"
]
},
"metadata": {
"link": {
"name": "text",
"url": "text"
},
"button": {
"payload": "text"
},
"reaction": {
"emoji": "text",
"action": "text"
},
"conversion": {
"type": "text",
"status": "text",
"method": "text",
"timestamp": "2025-07-01T22:50:53.285Z"
},
"prefetched": true,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]
}
WhatsApp supports the following message interactions:
Read
A user has read a message
Clicked
A user has clicked a quick reply button
Additional information about the interactions can be found in the details
field and metadata.button
object as follows:
Clicked
item_N_clicked
payload - user supplied payload sent in action button
Recipient clicked a quick reply button. N = the position of the item in the actions array of the associated message
Last updated
Was this helpful?