Receiving messages
Inbound messages
In this section, you can find sample messages of every inbound message type supported by the Channels API for Apple Messages. The code snippets in every subsection demonstrate how a Apple message is converted into a Channels API message.
See the following pages to understand more about retrieving messages or message statuses
Text
Text
{
"id": "7f3e9a21-4d5c-4a8b-9e72-3c8f1b6d4e90",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "Incoming message"
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"user_locale": "en-GB"
}
},
"reference": "",
"parts": [
{
"platformReference": "8e2f5a9c-3d7b-4c1e-9a6f-2d5b8c3e1a7f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:07:36.886Z",
"createdAt": "2025-12-03T14:07:36.744Z",
"updatedAt": "2025-12-03T14:07:36.886Z",
"batchId": null
}Reaction
{
"id": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b0c",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "Liked “Outgoing message”"
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2"
}
},
"reference": "",
"parts": [
{
"platformReference": "c6d7e8f9-a0b1-4c2d-3e4f-5a6b7c8d9e0f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T15:03:20.938Z",
"createdAt": "2025-12-03T15:03:20.719Z",
"updatedAt": "2025-12-03T15:03:20.938Z",
"batchId": null
}Image
Image
{
"id": "a3f8d6c2-7b4e-4f9a-8d1c-5e3b7f2a9d6c",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "image",
"image": {
"images": [
{
"mediaUrl": "https://media.api.bird.com/workspaces/bf89833c-380c-488a-ae9d-64477b455d74/messages/a3f8d6c2-7b4e-4f9a-8d1c-5e3b7f2a9d6c/media/ea7eb1eb-0d13-4ae0-90f8-fe1b246eb4b7"
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"user_locale": "en-GB"
}
},
"reference": "",
"parts": [
{
"platformReference": "d7c3f9a1-6e2b-4d8c-9f5a-3b7e1c4d8a6f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:08:23.714Z",
"createdAt": "2025-12-03T14:08:23.658Z",
"updatedAt": "2025-12-03T14:08:23.714Z",
"batchId": null
} Image with text
{
"id": "b8e4f1d9-3c6a-4e7b-9d2f-8a5c3e1b7d4f",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "image",
"image": {
"text": "Incoming image text",
"images": [
{
"mediaUrl": "https://media.api.bird.com/workspaces/bf89833c-380c-488a-ae9d-64477b455d74/messages/b8e4f1d9-3c6a-4e7b-9d2f-8a5c3e1b7d4f/media/037e3eaa-c67c-496a-b188-fbafa70ca68a"
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"user_locale": "en-GB"
}
},
"reference": "",
"parts": [
{
"platformReference": "f2d9c5a8-4e1b-4c7d-8f3a-6b2e9d1c5a7f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:08:46.696Z",
"createdAt": "2025-12-03T14:08:46.556Z",
"updatedAt": "2025-12-03T14:08:46.696Z",
"batchId": null
}File
File
{
"id": "c5a7e3f1-9d4b-4e8c-a2f6-7b3d9e1c5a8f",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "file",
"file": {
"files": [
{
"mediaUrl": "https://media.api.bird.com/workspaces/bf89833c-380c-488a-ae9d-64477b455d74/messages/c5a7e3f1-9d4b-4e8c-a2f6-7b3d9e1c5a8f/media/133b9c04-4f4b-462b-a517-5f5bf529ea60"
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"user_locale": "en-GB"
}
},
"reference": "",
"parts": [
{
"platformReference": "e8b2f5c9-3a7d-4e1c-9f6a-2d8b5c1e7a3f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:09:10.821Z",
"createdAt": "2025-12-03T14:09:10.763Z",
"updatedAt": "2025-12-03T14:09:10.821Z",
"batchId": null
}File with text
{
"id": "d9f3b6e2-8c5a-4d7e-b1f4-9a6c2e8d3b5f",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "file",
"file": {
"text": "Incoming video text",
"files": [
{
"mediaUrl": "https://media.api.bird.com/workspaces/bf89833c-380c-488a-ae9d-64477b455d74/messages/d9f3b6e2-8c5a-4d7e-b1f4-9a6c2e8d3b5f/media/6beb3461-f845-4226-9a03-3fe9064666c9"
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"user_locale": "en-GB"
}
},
"reference": "",
"parts": [
{
"platformReference": "a4e8d2f7-5c9b-4e3a-8d1f-6b2c7e9a3d5f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:09:25.589Z",
"createdAt": "2025-12-03T14:09:25.518Z",
"updatedAt": "2025-12-03T14:09:25.589Z",
"batchId": null
}Location
{
"id": "f7b3d8e9-4c2a-4e6f-8d5b-3a9c1e7f2d6b",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "location",
"location": {
"coordinates": {
"latitude": 51.499096,
"longitude": -0.110027
},
"location": {
"address": "Dropped Pin",
"label": "Dropped Pin"
}
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2"
}
},
"reference": "",
"parts": [
{
"platformReference": "b6c9e4f2-7d3a-4e8b-9f1c-5a2d8e6b3c7f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:09:55.122Z",
"createdAt": "2025-12-03T14:09:54.999Z",
"updatedAt": "2025-12-03T14:09:55.122Z",
"batchId": null
}Interactive message
Interactive message reply
{
"id": "e3c7f9d2-6a4b-4e8d-9f5c-2b8a1e6d3c9f",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "Yes",
"actions": [
{
"type": "postback",
"postback": {
"text": "Yes",
"payload": "1"
}
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"user_locale": "en-GB"
}
},
"reference": "",
"replyTo": {
"id": "712af417-78d2-49c1-8e34-70c224d62397",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "c8d5f2a9-4e7b-4d3c-8f6a-9b1e2d5c7a4f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:10:53.147Z",
"createdAt": "2025-12-03T14:10:53.077Z",
"updatedAt": "2025-12-03T14:10:53.147Z",
"batchId": null
}Interactive message postback
{
"id": "a5d8e6f3-9c2b-4e7d-8f4a-6b3c9e2d1a5f",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "Yes",
"actions": [
{
"type": "postback",
"postback": {
"text": "Yes",
"payload": "option-yes"
}
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"user_locale": "en-GB"
}
},
"reference": "",
"replyTo": {
"id": "fbecbe92-b2ea-4619-a92d-96ceb34e941d",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "d4f9e7c2-8a5b-4e3d-9f6c-2b8e1a7d5c3f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:11:24.636Z"Interactive message list
Single without payload or subtitle
{
"id": "f6e9c3d7-5a8b-4e2f-9d6c-3b7a1e4d8c2f",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "You selected an option: Option1"
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"selectedItem": "Option1",
"user_locale": "en-GB"
}
},
"reference": "",
"replyTo": {
"id": "b4ce41d5-4723-4d8e-95c8-0e7b0cd76dcd",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "e7c4f8d1-9a6b-4e3c-8f5d-2b9a7e1c6d4f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:28:22.586Z",
"createdAt": "2025-12-03T14:28:22.512Z",
"updatedAt": "2025-12-03T14:28:22.586Z",
"batchId": null
}Single select with payload or subtitle set
{
"id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "You selected an option: Option1",
"actions": [
{
"type": "postback",
"postback": {
"text": "You selected an option: Option1",
"payload": "subtitleO1"
}
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"selectedItem": "Option1",
"user_locale": "en-GB"
}
},
"reference": "",
"replyTo": {
"id": "f1e2d3c4-b5a6-4978-8e9d-0c1b2a3e4f5d",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "d1e2f3a4-b5c6-4d7e-8f9a-0b1c2d3e4f5a"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:50:00.000Z",
"createdAt": "2025-12-03T14:50:00.000Z",
"updatedAt": "2025-12-03T14:50:00.000Z",
"batchId": null
}Multi select with payload or subtitle set
{
"id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "You selected an option: Option1 and Option2",
"actions": [
{
"type": "postback",
"postback": {
"text": "You selected an option: Option1 and Option2",
"payload": "subtitleO1"
}
},
{
"type": "postback",
"postback": {
"text": "You selected an option: Option1 and Option2",
"payload": "subtitleO2"
}
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"selectedItem": "Option1 and Option2",
"user_locale": "en-GB"
}
},
"reference": "",
"replyTo": {
"id": "e2f3a4b5-c6d7-4e89-9f0a-1b2c3d4e5f6a",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "e2f3a4b5-c6d7-4e89-9f0a-1b2c3d4e5f6b"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:51:00.000Z",
"createdAt": "2025-12-03T14:51:00.000Z",
"updatedAt": "2025-12-03T14:51:00.000Z",
"batchId": null
}Mutiple section, single select with payload or subtitle set
{
"id": "c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "You selected an option: S1Option1 and S2Option1",
"actions": [
{
"type": "postback",
"postback": {
"text": "You selected an option: S1Option1 and S2Option1",
"payload": "subtitleS1O1"
}
},
{
"type": "postback",
"postback": {
"text": "You selected an option: S1Option1 and S2Option1",
"payload": "subtitleS2O1"
}
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"selectedItem": "S1Option1 and S2Option1",
"user_locale": "en-GB"
}
},
"reference": "",
"replyTo": {
"id": "f3a4b5c6-d7e8-4f90-a1b2-c3d4e5f6a7b8",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "f3a4b5c6-d7e8-4f90-a1b2-c3d4e5f6a7b9"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:52:00.000Z",
"createdAt": "2025-12-03T14:52:00.000Z",
"updatedAt": "2025-12-03T14:52:00.000Z",
"batchId": null
}Multiple section multiple selection with payload or subtitle set
{
"id": "b7e4f9c6-8d3a-4e5b-9f2d-6c8a1e3d5b7f",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "You selected an option: S1Option1, S1Option2, S2Option1, and S2Option2",
"actions": [
{
"type": "postback",
"postback": {
"text": "You selected an option: S1Option1, S1Option2, S2Option1, and S2Option2",
"payload": "subtitleS1O1"
}
},
{
"type": "postback",
"postback": {
"text": "You selected an option: S1Option1, S1Option2, S2Option1, and S2Option2",
"payload": "subtitleS1O2"
}
},
{
"type": "postback",
"postback": {
"text": "You selected an option: S1Option1, S1Option2, S2Option1, and S2Option2",
"payload": "subtitleS2O1"
}
},
{
"type": "postback",
"postback": {
"text": "You selected an option: S1Option1, S1Option2, S2Option1, and S2Option2",
"payload": "subtitleS2O2"
}
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"selectedItem": "S1Option1, S1Option2, S2Option1, and S2Option2",
"user_locale": "en-GB"
}
},
"reference": "",
"replyTo": {
"id": "5ebf912f-271b-45e1-a261-cc4f89508288",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "c4f7e9d2-5a8b-4e3c-9f6d-2b8a7e1c5d4f"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:42:58.365Z",
"createdAt": "2025-12-03T14:42:58.282Z",
"updatedAt": "2025-12-03T14:42:58.365Z",
"batchId": null
}Interactive message time
{
"id": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "You booked an appointment: 3 Dec 2025 at 15:55"
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"duration": "3600",
"selected": "3 Dec 2025 at 15:55",
"selectedTime": "1764777300",
"time": "2025-12-03T15:55:00.000000",
"timezoneOffset": "0",
"type": "select",
"user_locale": "en-GB"
}
},
"reference": "",
"replyTo": {
"id": "94f8d8cd-66e7-48a6-9c5f-59b185315f05",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "a4b5c6d7-e8f9-4a0b-1c2d-3e4f5a6b7c8d"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:55:54.325Z",
"createdAt": "2025-12-03T14:55:54.248Z",
"updatedAt": "2025-12-03T14:55:54.325Z",
"batchId": null
}Interactive message form
{
"id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
"channelId": "2b4d8c3f-7a92-4e1b-8d53-6f9e2a1c5b7d",
"sender": {
"contact": {
"id": "9d2c4e8a-1f7b-4c3d-a6e9-5b8f3d1a7c2e",
"identifierKey": "applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"identifierValue": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ=",
"platformAddressSelector": "identifiers.applebc-e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c",
"platformAddress": "urn:mbid:BQBBZ6hwUSvMnv/11MfK4NaFROky+ebG1nCeb4Oowghiun3n6Yo+c8eq07jQ8ey/oE+DquK2YnWxayzINDR+so0kslVoh9eTx+giUqt6rXqZYwtto2uRqEgd55yqdmc2f7c27NZYXacalfNl3n7083dv+TzqVXJ="
}
},
"receiver": {
"connector": {
"id": "3a7f2d9e-5c1b-4e8a-9f3d-6b8c1a4e7f2d",
"identifierValue": "e5a8f3c2-9d1b-4f7e-a3c6-8b2d5f9e1a4c"
}
},
"body": {
"type": "text",
"text": {
"text": "Form completed\nWhat is your name?: John Smith\nWhat is your age?: 48",
"actions": [
{
"type": "postback",
"postback": {
"text": "Form completed\nWhat is your name?: John Smith\nWhat is your age?: 48",
"payload": "GsfRYjThex_L4m0XtKJ4LX"
}
},
{
"type": "postback",
"postback": {
"text": "Form completed\nWhat is your name?: John Smith\nWhat is your age?: 48",
"payload": "DZr3B76qGYgJiK01hDeIuH"
}
}
]
}
},
"meta": {
"extraInformation": {
"capabilities": "AUTH,LIST,TIME,FORM,QUICK,AUTH2",
"user_locale": "en-GB"
},
"formResponse": {
"id": "00000000-0000-0000-0000-000000000000",
"template": "messageForms",
"sessionIdentifier": "079adade-f86c-4cc7-9fe5-acc98893851d",
"requestIdentifier": "079adade-f86c-4cc7-9fe5-acc98893851d",
"selections": [
{
"pageIdentifier": "GsfRYjThex_L4m0XtKJ4LX",
"items": [
{
"identifier": "GsfRYjThex_L4m0XtKJ4LX",
"value": "John Smith",
"type": "input",
"title": "John Smith"
}
],
"subtitle": "Please provide your name",
"title": "What is your name?"
},
{
"pageIdentifier": "DZr3B76qGYgJiK01hDeIuH",
"items": [
{
"identifier": "DZr3B76qGYgJiK01hDeIuH",
"value": "48",
"type": "input",
"title": "48"
}
],
"subtitle": "Please enter an age between 18-99",
"title": "What is your age?"
}
]
}
},
"reference": "",
"replyTo": {
"id": "079adade-f86c-4cc7-9fe5-acc98893851d",
"order": 0,
"type": "click"
},
"parts": [
{
"platformReference": "b5c6d7e8-f9a0-4b1c-2d3e-4f5a6b7c8d9e"
}
],
"status": "delivered",
"reason": "",
"direction": "incoming",
"context": {},
"chargeableUnits": 1,
"lastStatusAt": "2025-12-03T14:58:35.626Z",
"createdAt": "2025-12-03T14:58:35.548Z",
"updatedAt": "2025-12-03T14:58:35.626Z",
"batchId": null
}Last updated
Was this helpful?