Message interactions

You can list message interactions on a specific message using the following endpoint. In order to get a Telegram message, you must have an active Telegram channel and perform a HTTP request with a valid access key.

List message interactions

List message interactions

GET/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

messageId*string (uuid)

The ID for a message

channelId*string (uuid)

The ID for a channel

Response

200404

OK

Body

application/json

resultsarray of ChannelMessageInteraction

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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": 0,
      "receiver": {
        "connector": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifierValue": "text",
          "annotations": {
            "name": "text"
          }
        }
      },
      "createdAt": "2024-10-18T03:26:51.090Z",
      "details": "text",
      "metadata": {
        "link": {
          "name": "text",
          "url": "text"
        },
        "button": {
          "payload": "text"
        },
        "reaction": {
          "emoji": "text",
          "action": "text"
        }
      }
    }
  ]
}

Telegram supports the following message interactions:

Interaction	Description
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:

Interaction	details	metadata.button.	Description
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