Message interactions

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

GET

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

List message interactions

响应载荷

results

array of object

显示子属性

results.bodyTemplateProjectId

string

results.channelId

string

必填

results.context

object

必填

显示子属性

results.context.id

string

results.context.tagIds

array of string

results.context.type

string

results.createdAt

string

必填

results.details

string

results.id

string

必填

results.isFirstInteraction

boolean

results.isFirstInteractionIncludingBots

boolean

results.journey

object

显示子属性

results.journey.id

string

results.journey.name

string

results.journey.runId

string

results.journey.scheduleExecutionId

string

results.journey.stepId

string

results.messageCreatedAt

string

results.messageId

string

必填

results.messagePartsCount

integer

必填

results.messageReference

string

必填

results.messageTags

array of string

results.metadata

object

显示子属性

results.metadata.button

object

显示子属性

results.metadata.button.payload

string

必填

results.metadata.conversion

object

显示子属性

results.metadata.conversion.method

string

Method of entering the code

Possible values: unknown, manual, auto

results.metadata.conversion.status

string

Status of the conversion

Possible values: converted, canceled, not_converted, incorrect_code, resent, received_after_expiration

results.metadata.conversion.timestamp

string

Timestamp of when the conversion was recorded

results.metadata.conversion.type

string

Type of conversion

Possible values: otp, url, promo_code

results.metadata.extraInformation

object

results.metadata.link

object

显示子属性

results.metadata.link.clickType

string

Possible values: link, button

results.metadata.link.name

string

必填

results.metadata.link.url

string

必填

results.metadata.prefetched

boolean

results.metadata.reaction

object

显示子属性

results.metadata.reaction.action

string

必填

Possible values: react, unreact

results.metadata.reaction.emoji

string

必填

results.metadata.renderedContentBlocks

array of string

results.metadata.subscriptionList

object

显示子属性

results.metadata.subscriptionList.subscriptionListId

string

必填

results.notification

object

显示子属性

results.notification.template

string

results.notification.url

string

必填

results.platformId

string

必填

results.platformReferenceId

string

results.receiver

object

必填

显示子属性

results.receiver.connector

object

显示子属性

results.receiver.connector.annotations

object

Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.

显示子属性

results.receiver.connector.annotations.name

string

results.receiver.connector.id

string

必填

results.receiver.connector.identifierValue

string

The identifier value of the sender or receiver connector (e.g. email address or phone number).

results.receiver.connector.types

array of string

results.receiver.contacts

array of object

显示子属性

results.receiver.contacts.contactAnnotation

object

Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.

显示子属性

results.receiver.contacts.contactAnnotation.name

string

results.receiver.contacts.countryCode

string

results.receiver.contacts.id

string

The ID of the contact.

results.receiver.contacts.identifierKey

string

The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.

results.receiver.contacts.identifierValue

string

The identifier value for finding the contact.

results.receiver.contacts.identifiers

array of object

Additional identifiers to augment the contact during resolution.

显示子属性

results.receiver.contacts.identifiers.identifierKey

string

必填

The identifier key for finding the contact (e.g. emailaddress, phonenumber).

results.receiver.contacts.identifiers.identifierValue

string

必填

The identifier value for finding the contact.

results.receiver.contacts.platformAddress

string

The resolved platform address used to deliver the message (e.g. phone number or email address).

results.receiver.contacts.platformAddressSelector

string

An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.

results.receiver.contacts.receiverExpression

string

results.receiver.contacts.receiverValue

string

results.receiver.contacts.type

string

The type of the receiver (e.g. to, cc, bcc for email).

results.receiver.device

object

显示子属性

results.receiver.device.gateway

string

必填

Possible values: firebase, apns, web

results.receiver.device.id

string

必填

results.receiver.device.identifierValue

string

必填

results.receiver.inbox

object

显示子属性

results.receiver.inbox.emailRecipientType

string

results.receiver.inbox.id

string

必填

results.receiver.inbox.identifierKey

string

必填

results.receiver.inbox.identifierValue

string

必填

results.receiver.inbox.type

string

必填

Possible values: user, group

results.receiver.userContacts

array of object

显示子属性

results.receiver.userContacts.id

string

必填

results.receiver.userContacts.identifierKey

string

必填

results.receiver.userContacts.identifierValue

string

必填

results.receiver.userContacts.type

string

results.type

string

必填

Possible values: invalid, read, opened, clicked, reported-as-spam, unsubscribe-request, delete, reaction, subscribe-request, subscribe-consent, conversion

results.useCaseType

string

Possible values: unspecified, marketing, otp, transactional, conversation, test

代码示例

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Apple Messages 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 an action (reply, postback, list, form, payment,authentication)

Examples

Reply interaction

代码示例

{
  "id": "a3f7c2e9-5d8b-4e6a-9f1c-7b4d2e8a6c3f",
  "type": "clicked",
  "createdAt": "2025-12-03T12:45:46.001Z",
  "messageId": "b8e4d9c3-7a5f-4e2b-8d6c-9a1e3f7b5c2d",
  "channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
  "platformId": "apple-business-chat",
  "messageReference": "c9d5e7f2-8a4b-4e3d-9f6c-5b8a1e2d7c4f",
  "messagePartsCount": 2,
  "messageTags": null,
  "context": {
    "type": "conversation_message",
    "id": "d4e8f6a9-3c7b-4e5d-8f2a-9b6c1e4d7a5f:b8e4d9c3-7a5f-4e2b-8d6c-9a1e3f7b5c2d:9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e"
  },
  "receiver": {
    "contacts": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "identifierKey": "",
        "identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
        "platformAddress": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
      }
    ]
  },
  "details": "item_1_clicked",
  "metadata": {
    "extraInformation": {
      "chargeable_unit": "2",
      "conversation.visibility": "public",
      "useCase": "conversation"
    },
    "button": {
      "payload": "1"
    }
  }
}

Postback interaction

代码示例

{
  "id": "e7b9d4f6-a2c8-4e5d-9f3b-6c8a2e1d5f7b",
  "type": "clicked",
  "createdAt": "2025-12-03T14:11:23.458Z",
  "messageId": "f5c8e9a4-7b3d-4e6f-8d2c-9a5b1e7d4c6f",
  "channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
  "platformId": "apple-business-chat",
  "messageReference": "d6e9f3a7-4c5b-4e8d-9f2a-6b8c1e3d7f5a",
  "messagePartsCount": 2,
  "messageTags": null,
  "context": {
    "type": "conversation_message",
    "id": "a8f3d6e9-5c4b-4e7d-9f2a-8b6c3e1d5a7f:f5c8e9a4-7b3d-4e6f-8d2c-9a5b1e7d4c6f:9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e"
  },
  "receiver": {
    "contacts": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "identifierKey": "",
        "identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
        "platformAddress": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
      }
    ]
  },
  "details": "item_option-yes_clicked",
  "metadata": {
    "extraInformation": {
      "chargeable_unit": "2",
      "conversation.visibility": "public",
      "useCase": "conversation"
    },
    "button": {
      "payload": "option-yes"
    }
  }
}

List interaction

代码示例

{
  "id": "b9e6d3f8-a5c7-4e2d-9f4b-7c8a3e1d6f5b",
  "type": "clicked",
  "createdAt": "2025-12-03T14:42:56.849Z",
  "messageId": "c7f4e8a6-9b3d-4e5c-8f2a-6b9c1e4d7a5f",
  "channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
  "platformId": "apple-business-chat",
  "messageReference": "d8e5f9a3-6c4b-4e7d-9f2a-8b6c3e1d5a7f",
  "messagePartsCount": 1,
  "messageTags": null,
  "context": {
    "type": "conversation_message",
    "id": "e9f6a4d7-5c8b-4e3d-9f2a-6b8c1e7d4a5f:c7f4e8a6-9b3d-4e5c-8f2a-6b9c1e4d7a5f:9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e"
  },
  "receiver": {
    "contacts": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "identifierKey": "",
        "identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
        "platformAddress": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
      }
    ]
  },
  "details": "item_subtitleS1O1_clicked",
  "metadata": {
    "extraInformation": {
      "chargeable_unit": "1",
      "conversation.visibility": "public",
      "useCase": "conversation"
    },
    "button": {
      "payload": "subtitleS1O1"
    }
  }
}

Time interaction

代码示例

{
  "id": "f4d8e7a9-b6c5-4e3d-9f2a-8b7c6e1d4a5f",
  "type": "clicked",
  "createdAt": "2025-12-03T14:55:52.718Z",
  "messageId": "a6e9f5c8-7b4d-4e3a-9f2c-6b8a1e5d7c4f",
  "channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
  "platformId": "apple-business-chat",
  "messageReference": "b7f3e8a4-6c5d-4e9a-8f2b-9c6a1e7d4f5a",
  "messagePartsCount": 1,
  "messageTags": null,
  "context": {
    "type": "conversation_message",
    "id": "c8d4f9a6-5e7b-4e3d-9f2a-8b6c1e4d7a5f:a6e9f5c8-7b4d-4e3a-9f2c-6b8a1e5d7c4f:9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e"
  },
  "receiver": {
    "contacts": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "identifierKey": "",
        "identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
        "platformAddress": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
      }
    ]
  },
  "details": "item_{\"duration\":\"3600\",\"startTime\":\"2025-12-03 15:55:28.398 +0000 UTC\"}_clicked",
  "metadata": {
    "extraInformation": {
      "chargeable_unit": "1",
      "conversation.visibility": "public",
      "duration": "3600",
      "identifier": "{\"duration\":\"3600\",\"startTime\":\"2025-12-03 15:55:28.398 +0000 UTC\"}",
      "startTime": "1764777300",
      "useCase": "conversation"
    }
  }
}