> For the complete documentation index, see [llms.txt](https://docs.bird.com/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bird.com/api/channels-api/supported-channels/programmable-apple-messages/message-interactions.md). # 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. ## List message interactions > List message interactions ```json {"openapi":"3.0.3","info":{"title":"Channels","version":"v1"},"servers":[{"url":"https://api.bird.com","description":"Production API"}],"security":[{"accessKey":[]}],"components":{"securitySchemes":{"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"schemas":{"MessageInteractionsList":{"type":"object","title":"ChannelMessageInteractionsList","description":"A list of channel messages interactions","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/channels.messages.interactions.interaction"}}}},"channels.messages.interactions.interaction":{"properties":{"bodyTemplateProjectId":{"format":"uuid","type":"string"},"channelId":{"format":"uuid","type":"string"},"context":{"$ref":"#/components/schemas/channels.messages.context"},"createdAt":{"format":"date-time","type":"string"},"details":{"type":"string"},"id":{"format":"uuid","type":"string"},"isFirstInteraction":{"type":"boolean"},"isFirstInteractionIncludingBots":{"type":"boolean"},"journey":{"$ref":"#/components/schemas/channels.messages.metadata.flow"},"messageCreatedAt":{"format":"date-time","type":"string"},"messageId":{"format":"uuid","type":"string"},"messagePartsCount":{"format":"int32","type":"integer"},"messageReference":{"type":"string"},"messageTags":{"items":{"type":"string"},"type":"array"},"metadata":{"$ref":"#/components/schemas/channels.messages.interactions.metadata"},"notification":{"$ref":"#/components/schemas/channels.notifications.message_notification"},"platformId":{"type":"string"},"platformReferenceId":{"type":"string"},"receiver":{"$ref":"#/components/schemas/channels.participants.receiver"},"type":{"$ref":"#/components/schemas/channels.messages.interactions.type"},"useCaseType":{"$ref":"#/components/schemas/channels.use_case_type"}},"required":["id","type","createdAt","messageId","channelId","platformId","messageReference","messagePartsCount","receiver","context"],"type":"object"},"channels.messages.context":{"properties":{"id":{"type":"string"},"tagIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"channels.messages.metadata.flow":{"properties":{"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"runId":{"format":"uuid","type":"string"},"scheduleExecutionId":{"format":"uuid","type":"string"},"stepId":{"type":"string"}},"title":"Message Flow Meta","type":"object"},"channels.messages.interactions.metadata":{"properties":{"button":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.button"},"conversion":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.conversion"},"extraInformation":{"additionalProperties":{"type":"string"},"type":"object"},"link":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.link"},"prefetched":{"type":"boolean"},"reaction":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.reaction"},"renderedContentBlocks":{"items":{"type":"string"},"type":"array"},"subscriptionList":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.subscription_list"}},"type":"object"},"channels.messages.interactions.metadata.button":{"properties":{"payload":{"type":"string"}},"required":["payload"],"type":"object"},"channels.messages.interactions.metadata.conversion":{"properties":{"method":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.conversion_method"},"status":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.conversion_status"},"timestamp":{"description":"Timestamp of when the conversion was recorded","format":"date-time","type":"string"},"type":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.conversion_type"}},"title":"Channel Message Conversion","type":"object"},"channels.messages.interactions.metadata.conversion_method":{"description":"Method of entering the code","enum":["unknown","manual","auto"],"title":"Message Interaction Conversion Method","type":"string"},"channels.messages.interactions.metadata.conversion_status":{"description":"Status of the conversion","enum":["converted","canceled","not_converted","incorrect_code","resent","received_after_expiration"],"title":"Message Interaction Conversion Status","type":"string"},"channels.messages.interactions.metadata.conversion_type":{"description":"Type of conversion","enum":["otp","url","promo_code"],"title":"Message Interaction Conversion Type","type":"string"},"channels.messages.interactions.metadata.link":{"properties":{"clickType":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.link_click_type"},"name":{"type":"string"},"url":{"type":"string"}},"required":["name","url"],"type":"object"},"channels.messages.interactions.metadata.link_click_type":{"enum":["link","button"],"title":"Message Interaction Link Click Type","type":"string"},"channels.messages.interactions.metadata.reaction":{"properties":{"action":{"$ref":"#/components/schemas/channels.messages.interactions.metadata.reaction_action"},"emoji":{"type":"string"}},"required":["emoji","action"],"type":"object"},"channels.messages.interactions.metadata.reaction_action":{"enum":["react","unreact"],"title":"Message Interaction Reaction Action","type":"string"},"channels.messages.interactions.metadata.subscription_list":{"properties":{"subscriptionListId":{"format":"uuid","type":"string"}},"required":["subscriptionListId"],"type":"object"},"channels.notifications.message_notification":{"properties":{"template":{"type":"string"},"url":{"type":"string"}},"required":["url"],"type":"object"},"channels.participants.receiver":{"properties":{"connector":{"$ref":"#/components/schemas/channels.participants.connector"},"contacts":{"items":{"$ref":"#/components/schemas/channels.participants.contact"},"type":"array"},"device":{"$ref":"#/components/schemas/channels.participants.device"},"inbox":{"$ref":"#/components/schemas/channels.participants.inbox"},"userContacts":{"items":{"$ref":"#/components/schemas/channels.participants.user_contact"},"type":"array"}},"type":"object"},"channels.participants.connector":{"properties":{"annotations":{"$ref":"#/components/schemas/channels.participants.contact_annotation"},"id":{"format":"uuid","type":"string"},"identifierValue":{"description":"The identifier value of the sender or receiver connector (e.g. email address or phone number).","type":"string"},"types":{"items":{"type":"string"},"type":"array"}},"required":["id"],"type":"object"},"channels.participants.contact_annotation":{"description":"Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.","properties":{"name":{"type":"string"}},"type":"object"},"channels.participants.contact":{"properties":{"contactAnnotation":{"$ref":"#/components/schemas/channels.participants.contact_annotation"},"countryCode":{"type":"string"},"id":{"description":"The ID of the contact.","format":"uuid","type":"string"},"identifierKey":{"description":"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.","type":"string"},"identifierValue":{"description":"The identifier value for finding the contact.","type":"string"},"identifiers":{"description":"Additional identifiers to augment the contact during resolution.","items":{"$ref":"#/components/schemas/channels.participants.identifier"},"type":"array"},"platformAddress":{"description":"The resolved platform address used to deliver the message (e.g. phone number or email address).","type":"string"},"platformAddressSelector":{"description":"An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.","type":"string"},"receiverExpression":{"type":"string"},"receiverValue":{"type":"string"},"type":{"description":"The type of the receiver (e.g. to, cc, bcc for email).","type":"string"}},"type":"object"},"channels.participants.identifier":{"properties":{"identifierKey":{"description":"The identifier key for finding the contact (e.g. emailaddress, phonenumber).","type":"string"},"identifierValue":{"description":"The identifier value for finding the contact.","type":"string"}},"required":["identifierKey","identifierValue"],"type":"object"},"channels.participants.device":{"properties":{"gateway":{"$ref":"#/components/schemas/channels.participants.push_notification_gateway"},"id":{"format":"uuid","type":"string"},"identifierValue":{"type":"string"}},"required":["id","identifierValue","gateway"],"type":"object"},"channels.participants.push_notification_gateway":{"enum":["firebase","apns","web"],"type":"string"},"channels.participants.inbox":{"properties":{"emailRecipientType":{"type":"string"},"id":{"format":"uuid","type":"string"},"identifierKey":{"type":"string"},"identifierValue":{"type":"string"},"type":{"$ref":"#/components/schemas/channels.inbox_type"}},"required":["id","type","identifierKey","identifierValue"],"type":"object"},"channels.inbox_type":{"enum":["user","group"],"type":"string"},"channels.participants.user_contact":{"properties":{"id":{"format":"uuid","type":"string"},"identifierKey":{"type":"string"},"identifierValue":{"type":"string"},"type":{"type":"string"}},"required":["id","identifierKey","identifierValue"],"type":"object"},"channels.messages.interactions.type":{"enum":["invalid","read","opened","clicked","reported-as-spam","unsubscribe-request","delete","reaction","subscribe-request","subscribe-consent","conversion"],"title":"Message Interaction Type","type":"string"},"channels.use_case_type":{"enum":["unspecified","marketing","otp","transactional","conversation","test"],"type":"string"},"error.detailed":{"additionalProperties":false,"description":"An error returned from the API that includes additional details about the error. The `details` property can contain any additional information about the error that may be helpful for debugging or understanding the error.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":true,"description":"Any additional information about the error that may be helpful for debugging or understanding the error.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"DetailedError","type":"object"}},"responses":{"requestError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.detailed"}}},"description":"An error"}}},"paths":{"/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions":{"get":{"summary":"List message interactions","operationId":"listChannelMessageInteractions","description":"List message interactions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageInteractionsList"}}}},"404":{"$ref":"#/components/responses/requestError"}}}}}} ``` Apple Messages supports the following [message interactions](/api/channels-api/message-status-and-interactions.md#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:
Interactiondetailsmetadata.button.Description
Clickeditem_N_clicked
  • payload - user supplied payload sent in action button
Recipient clicked an action (reply, postback, list, form, payment,authentication)
### Examples #### Reply interaction {% code lineNumbers="true" %} ```json { "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" } } } ``` {% endcode %} #### Postback interaction {% code lineNumbers="true" %} ```json { "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" } } } ``` {% endcode %} #### List interaction {% code lineNumbers="true" %} ```json { "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" } } } ``` {% endcode %} #### Time interaction {% code lineNumbers="true" %} ```json { "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" } } } ``` {% endcode %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.bird.com/api/channels-api/supported-channels/programmable-apple-messages/message-interactions.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.