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

get

List message interactions

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

messageIdstring · uuidRequired

The ID for a message

channelIdstring · uuidRequired

The ID for a channel

Responses

200

OK

application/json

404

An error

application/json

get

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

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "bodyTemplateProjectId": "123e4567-e89b-12d3-a456-426614174000",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "context": {
        "id": "text",
        "tagIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "type": "text"
      },
      "createdAt": "2026-06-16T21:06:26.815Z",
      "details": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isFirstInteraction": true,
      "isFirstInteractionIncludingBots": true,
      "journey": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "runId": "123e4567-e89b-12d3-a456-426614174000",
        "scheduleExecutionId": "123e4567-e89b-12d3-a456-426614174000",
        "stepId": "text"
      },
      "messageCreatedAt": "2026-06-16T21:06:26.815Z",
      "messageId": "123e4567-e89b-12d3-a456-426614174000",
      "messagePartsCount": 1,
      "messageReference": "text",
      "messageTags": [
        "text"
      ],
      "metadata": {
        "button": {
          "payload": "text"
        },
        "conversion": {
          "method": "unknown",
          "status": "converted",
          "timestamp": "2026-06-16T21:06:26.815Z",
          "type": "otp"
        },
        "extraInformation": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "link": {
          "clickType": "link",
          "name": "text",
          "url": "text"
        },
        "prefetched": true,
        "reaction": {
          "action": "react",
          "emoji": "text"
        },
        "renderedContentBlocks": [
          "text"
        ],
        "subscriptionList": {
          "subscriptionListId": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "notification": {
        "template": "text",
        "url": "text"
      },
      "platformId": "text",
      "platformReferenceId": "text",
      "receiver": {
        "connector": {
          "annotations": {
            "name": "text"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifierValue": "text",
          "types": [
            "text"
          ]
        },
        "contacts": [
          {
            "contactAnnotation": {
              "name": "text"
            },
            "countryCode": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "identifierKey": "text",
            "identifierValue": "text",
            "identifiers": [
              {
                "identifierKey": "text",
                "identifierValue": "text"
              }
            ],
            "platformAddress": "text",
            "platformAddressSelector": "text",
            "receiverExpression": "text",
            "receiverValue": "text",
            "type": "text"
          }
        ],
        "device": {
          "gateway": "firebase",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifierValue": "text"
        },
        "inbox": {
          "emailRecipientType": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifierKey": "text",
          "identifierValue": "text",
          "type": "user"
        },
        "userContacts": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "identifierKey": "text",
            "identifierValue": "text",
            "type": "text"
          }
        ]
      },
      "type": "invalid",
      "useCaseType": "unspecified"
    }
  ]
}

Telegram supports the following message interactions:

Interaction	Description
Clicked	A user has clicked a quick reply button
Reaction	A user reacting to a message using an emoji

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