Enterprise Communications APIGet StartedReference
Reference
Select ProductPortal

One API - Message Events

All messages sent via the One API can provide message status webhook events. You can subscribe your webhook to receive these events to understand the status of your message sends, but only subscribe to the message events you need to avoid overheads.

The message events themselves are usually used to understand the status of a message with additional detail contained within the events payload, if required. A message can generate the following message events:

964

Possible message webhook events

So in a typical message send you could receive the following webhook events:

  • message.sent - Your message has been sent on the channel
  • Once the final status is known you will receive on of the following events:
    • message.delivered - Your message has been delivered
    • message.read - Your message has been read/opened (On channels that support it)
    • message.expired - Your message wasn't delivered within the expiresOn time window, or the channels default time window
    • message.failed - The message failed to be delivered

More details on the message webhook events, their schema and examples can be found below:

Sent

This event indicates a message has been sent on a channel.

Examples

{
  "eventId": "0dceaf0d-93ea-4314-a6f8-b0cffe69799a",
  "accountId": 1234,
  "apiSpaceId": "c924cf6e-4352-4b26-a71a-c2032bea7a01",
  "name": "message.sent",
  "payload": {
    "details": {
      "channel": "sms",
      "additionalInfo": {
        "to": "447123123123",
        "successful": true,
        "clientRef": "e9f154c8-4011-493f-bb73-09cfcf8a1411"
      },
      "channelStatus": {
        "sms": {
          "status": "sent",
          "details": {
            "to": "447123123123",
            "successful": true,
            "clientRef": "e9f154c8-4011-493f-bb73-09cfcf8a1411"
          },
          "updatedOn": "2017-08-31T09:26:14.798Z"
        }
      }
    },
    "channelData": {
      "sms": {
        "phoneNumberCountryCode": "GB",
        "segmentCount": 1
      }
    },
    "updatedOn": "2017-08-31T09:26:14.799Z",
    "metadata": {
      "data": "My correlation data"
    },
    "id": "e9f154c8-4011-493f-bb73-09cfcf8a1411"
  },
  "revision": 2,
  "etag": "\"2e-PLB2C6w/yVdPjUhuRiZtlvt8k0Q\"",
  "timestamp": "2017-08-31T09:26:14.604Z"
}

{
  "eventId": "e0c3111b-d3a2-4042-96da-c92dfc7e1c52",
  "accountId": 1234,
  "apiSpaceId": "fe42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.sent",
  "payload": {
    "id": "89a31d97-b23e-41db-be4c-087df2136bd0",
    "details": {
      "channel": "rcs",
      "additionalInfo": {
        "name": "phones/+4477123123123/agentMessages/89a31d97-b23e-41db-be4c-087df2136bd0",
        "sendTime": "2019-10-23T16:03:33.677Z",
        "contentMessage": {
          "text": "Sending is easy with One API"
        }
      },
      "channelStatus": {}
    },
    "metadata": {
      "data": "My important data"
    },
    "updatedOn": "2019-10-23T16:03:32.468Z",
    "channelData": {
      "rcs": {
        "phoneNumber": "447123123123",
        "phoneNumberCountryCode": "GB",
        "agentId": "770950354877"
      }
    }
  },
  "revision": 2,
  "etag": "\"2e-7gE/WwkZra5g83pnw9iaeuI/NJw\"",
  "timestamp": "2019-10-23T16:03:33.697Z"
}

{
    "eventId": "9e520af1-2ec5-40e0-98fb-e3d44e4cc56b",
    "accountId": 1234,
    "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.sent",
    "payload": {
        "id": "0ae9d525-b8e4-4784-93be-4ba8c2c376ef",
        "details": {
            "channel": "whatsApp",
            "channelStatus": {
                "id": "gBEGRHcVF4YFAgmKRCcf_QOylqA",
                "status": "sent",
                "timestamp": "1606401011"
            }
        },
        "channelData": {
            "whatsApp": {
                "virtualDeviceNumber": "447700600000",
                "isHsm": false,
                "isWithinConversationWindow": true,
                "phoneNumberCountryCode": "GB"
            }
        },        
        "updatedOn": "2020-11-26T14:30:11.000Z"
    },
    "revision": 3,
    "etag": "\"2e-orUTAspXs8Vu0vRq+5o4BFTV5e4\"",
    "timestamp": "2020-11-26T14:30:12.148Z"
}

{
  "eventId": "487b9258-aee0-48da-b410-b253823fda10",
  "accountId": 1234,
  "apiSpaceId": "fa42e8af-5fc4-40d4-a38c-034535c0a385",
  "name": "message.sent",
  "payload": {
    "details": {
      "channel": "fbMessenger",
      "additionalInfo": {
        "fbMessengerId": "1924625277845988",
        "messageId": "mid.$cABAnV7v5AVdiiyqOdVcWeVGDyz-6"
      },
      "channelStatus": {
        "fbMessenger": {
          "status": "sent",
          "details": {
            "fbMessengerId": "1924625277645988",
            "messageId": "mid.$cABAnV7v5AVdiiyqOdVcWeVGDyz-6"
          },
          "updatedOn": "2017-05-30T15:06:56.934Z"
        }
      }
    },
    "updatedOn": "2017-05-30T15:06:56.934Z",
    "id": "79b156e6-c314-4114-ac6a-be8eab624951"
  },
  "revision": 2,
  "etag": "\"2e-Zb4yVYmVGmr9WRNuY47SF8Vd21I\"",
  "timestamp": "2017-05-30T15:06:57.592Z"
}

{
    "eventId": "b24a054b-0b23-4156-a88e-f8ef8a048a3b",
    "accountId": 1234,
    "apiSpaceId": "fe42e8af-5fc3-40b4-a38c-034535c9a385",
    "name": "message.sent",
    "payload": {
        "id": "f89de9a2-8f6f-479f-be8b-b3db017aa3f9",
        "details": {
            "channel": "twitterDm",
            "channelStatus": {}
        },
        "updatedOn": "2018-10-02T08:11:20.823Z"
    },
    "revision": 2,
    "etag": "\"2e-xn+2bjUkDccUSHXMprMfXnrb1p8\"",
    "timestamp": "2018-10-02T08:11:21.172Z"
}

{
    "eventId": "769f4305-ea98-45ae-860b-a32e44b9aa47",
    "accountId": 1234,
    "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.sent",
    "payload": {
        "id": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
        "details": {
            "channel": "appMessaging",
            "additionalInfo": {
                "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "conversationMessageId": "8b6076fe-4c85-4f92-a195-3625a7a62c32"
            },
            "channelStatus": {}
        },
        "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
        "updatedOn": "2019-03-07T10:37:21.529Z"
    },
    "revision": 2,
    "etag": "\"2e-lvaY1DE4bB43iP6/vi6xlcm3rGI\"",
    "timestamp": "2019-03-07T10:37:21.640Z"
}

Delivered

This event indicates that a message has been delivered on a channel, if delivery receipts are supported on the channel.

Examples

{
  "eventId": "2b612e8c-b88d-485c-8e98-81939f879500",
  "accountId": 1234,
  "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
  "name": "message.delivered",
  "payload": {
    "details": {
      "channel": "sms",
      "channelStatus": {
        "tranid": "946245251",
        "messageguid": "9fd260a5-52a7-4d84-bc08-10e04d07d7b7",
        "statusid": "1",
        "recipient": "447123123123",
        "statusdescription": "Messages delivered to handset",
        "datetime": "2017-08-31T10:28:00.143",
        "clientref": "e9f154c8-4011-493f-bb73-09cfcf8a1411",
        "submissiontime": "2017-08-31T10:26:14.317",
        "apispaceid": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
        "statustimeutc": "2017-08-31T09:27:21.000Z"
      }
    },
    "metadata": {
      "data": "My correlation data"
    },
    "id": "e9f154c8-4011-493f-bb73-09cfcf8a1411"
  },
  "revision": 3,
  "etag": "\"2e-oazq69nFeiKkl5WM78YH7xo/8xU\"",
  "timestamp": "2017-08-31T09:28:03.074Z"
}

{
  "eventId": "07006cd8-b9b0-4554-ae49-f6bc7b7a22b9",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.delivered",
  "payload": {
    "id": "df80de47-d2d7-436f-afe0-7559f64b0583",
    "details": {
      "channel": "rcs",
      "channelStatus": {
        "data": {
          "senderPhoneNumber": "+447123123123",
          "eventType": "DELIVERED",
          "eventId": "MsuYXA9p9FTcKajFDiwiELqA",
          "messageId": "df80de47-d2d7-436f-afe0-7559f64b0583",
          "sendTime": "2019-10-23T16:17:09.331989Z"
        },
        "attributes": {
          "type": "event",
          "project_number": "770950354877",
          "event_type": "DELIVERED",
          "product": "RBM"
        },
        "messageId": "653513593921442",
        "publishTime": "2019-10-23T16:17:10.329Z"
      }
    },
    "metadata": {
      "data": "My important data"
    },
    "updatedOn": "2019-10-23T16:17:11.325Z"
  },
  "revision": 3,
  "etag": "\"2e-Gcg41t6jFwT2CVW8wouZDroNu9Y\"",
  "timestamp": "2019-10-23T16:17:11.328Z"
}

{
    "eventId": "34604126-11f2-4bc0-9c14-7f65d1290870",
    "accountId": 1234,
    "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.delivered",
    "payload": {
        "id": "0ae9d525-b8e4-4784-93be-4ba8c2c376ef",
        "details": {
            "channel": "whatsApp",
            "channelStatus": {
                "id": "gBEGRHcVF4YFAgmKRCcf_QOylqA",
                "recipient_id": "447123123123",
                "status": "delivered",
                "timestamp": "1606401012"
            }
        },
        "updatedOn": "2020-11-26T14:30:12.000Z"
    },
    "revision": 4,
    "etag": "\"2e-E3HDAUG69mQES6x8YIZTeYSUHck\"",
    "timestamp": "2020-11-26T14:30:13.329Z"
}

{
  "eventId": "77775ef0-60f9-4ec1-8fa5-cfc3990e1f94",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.delivered",
  "payload": {
    "details": {
      "channel": "fbMessenger",
      "channelStatus": {
        "sender": {
          "id": "1124625277645988"
        },
        "recipient": {
          "id": "138143536705220"
        },
        "timestamp": 1496248541996,
        "delivery": {
          "watermark": 1496248541613,
          "seq": 0
        }
      }
    },
    "updatedOn": "2017-05-31T16:35:41.613Z",
    "id": "0bc1e71e-28f4-40f4-853a-7112fd28f627"
  },
  "revision": 3,
  "etag": "\"2e-5L1Qw6Yi1fL1KMW7AH2amYIvNSI\"",
  "timestamp": "2017-05-31T16:35:43.078Z"
}

{
    "eventId": "ae467606-6dd3-4eb5-aa9a-1901e1e8cecd",
    "accountId": 1234,
    "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.delivered",
    "payload": {
        "id": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
        "details": {
            "channel": "appMessaging",
            "channelStatus": {
                "messageId": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
                "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "scope": "a2p",
                "direction": "outbound",
                "sentOn": "2019-03-07T10:37:21.624Z",
                "isPublicConversation": false,
                "profileId": "anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "timestamp": "2019-03-07T10:37:21.737Z"
            }
        },
        "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
        "updatedOn": "2019-03-07T10:37:21.737Z"
    },
    "revision": 3,
    "etag": "\"2e-E+VfGOH5aZPuHpiCVUOfy63gnNY\"",
    "timestamp": "2019-03-07T10:37:21.847Z"
}

Read

This event indicates a message has been read on a channel, note this only applies to channels that support read receipts.

Examples

{
  "eventId": "8a418712-a341-480a-9e61-e750ee27cde2",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.read",
  "payload": {
    "id": "208bd9df-efd0-42d2-9f4a-56f97258c3a1",
    "details": {
      "channel": "rcs",
      "channelStatus": {
        "data": {
          "senderPhoneNumber": "+447123123123",
          "eventType": "READ",
          "eventId": "MsFHSpJVEUSRKSZQkEX4NNmg",
          "messageId": "208bd9df-efd0-42d2-9f4a-56f97258c3a1",
          "sendTime": "2019-10-24T08:36:49.527958Z"
        },
        "attributes": {
          "type": "event",
          "project_number": "770950354877",
          "event_type": "READ",
          "product": "RBM"
        },
        "messageId": "653537493453991",
        "publishTime": "2019-10-24T08:36:50.349Z"
      }
    },
    "metadata": {
      "data": "My important data"
    },
    "updatedOn": "2019-10-24T08:36:51.027Z"
  },
  "revision": 4,
  "etag": "\"2e-TxeQvmtFPwKmf7wpfCirDLiBf1o\"",
  "timestamp": "2019-10-24T08:36:51.032Z"
}

{
    "eventId": "1d081181-af78-4697-bc21-37283c0a9fb9",
    "accountId": 1234,
    "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.read",
    "payload": {
        "id": "0ae9d525-b8e4-4784-93be-4ba8c2c376ef",
        "details": {
            "channel": "whatsApp",
            "channelStatus": {
                "id": "gBEGRHcVF4YFAgmKRCcf_QOylqA",
                "recipient_id": "447123123123",
                "status": "read",
                "timestamp": "1606401029"
            }
        },
        "updatedOn": "2020-11-26T14:30:29.000Z"
    },
    "revision": 5,
    "etag": "\"2e-g9F3UlDwDBkT9HfetllpgTRDyB4\"",
    "timestamp": "2020-11-26T14:30:29.805Z"
}

{
  "eventId": "4fb53a11-48a0-46e6-af4c-946556f03445",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.read",
  "payload": {
    "details": {
      "channel": "fbMessenger",
      "channelStatus": {
        "sender": {
          "id": "1124625277645988"
        },
        "recipient": {
          "id": "138143536705220"
        },
        "timestamp": 1496248566710,
        "read": {
          "watermark": 1496248541613,
          "seq": 0
        }
      }
    },
    "updatedOn": "2017-05-31T16:35:41.613Z",
    "id": "0bc1e71e-28f4-40f4-853a-7112fd28f627"
  },
  "revision": 4,
  "etag": "\"2e-konny6DS4WEpVq5z2UDXb98kYQw\"",
  "timestamp": "2017-05-31T16:36:07.407Z"
}

{
    "eventId": "762e22d0-23ce-4d91-bad2-f273871ded0f",
    "accountId": 1234,
    "apiSpaceId": "fe42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.read",
    "payload": {
        "id": "bff606d0-33d2-4791-82b0-24fa2e3564fb",
        "details": {
            "channel": "twitterDm",
            "channelStatus": {
                "data": {
                    "created_timestamp": "1538469171303",
                    "sender_id": "812306064336760832",
                    "target": {
                        "recipient_id": "884511511659708416"
                    },
                    "last_read_event_id": "1047041674562686980"
                },
                "user": {
                    "id": "812306064336760832",
                    "created_timestamp": "1500385225907",
                    "name": "Joe Bloggs",
                    "screen_name": "JBloggs",
                    "protected": false,
                    "verified": false,
                    "followers_count": 1,
                    "friends_count": 12,
                    "statuses_count": 0,
                    "profile_image_url": "http://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png",
                    "profile_image_url_https": "https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png"
                }
            }
        },
        "updatedOn": "2018-10-02T08:32:51.303Z"
    },
    "revision": 3,
    "etag": "\"2e-kJ7vnMlELFImgCEV/uKkywPogRo\"",
    "timestamp": "2018-10-02T08:32:51.787Z"
}

{
    "eventId": "43a708b8-e884-49d6-92eb-cd75b7707f52",
    "accountId": 1234,
    "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.read",
    "payload": {
        "id": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
        "details": {
            "channel": "appMessaging",
            "channelStatus": {
                "messageId": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
                "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "scope": "a2p",
                "direction": "outbound",
                "sentOn": "2019-03-07T10:37:21.624Z",
                "isPublicConversation": false,
                "profileId": "anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "timestamp": "2019-03-07T10:37:21.750Z"
            }
        },
        "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
        "updatedOn": "2019-03-07T10:37:21.750Z"
    },
    "revision": 4,
    "etag": "\"2e-kvIDONdrGVEMD3E2ElniLL62jcA\"",
    "timestamp": "2019-03-07T10:37:21.864Z"
}

Expired

This event indicates a message has not been delivered within the specified expiry period.

Examples

{
  "eventId": "c88f35a8-5fe7-4069-9151-f4dcf8ee89b3",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.expired",
  "payload": {
    "details": {
      "channel": "sms",
      "channelStatus": {}
    },
    "updatedOn": "2017-06-01T10:45:05.685Z",
    "id": "a3c0c65c-6199-43e1-ba43-e7184a583e86"
  },
  "revision": 3,
  "etag": "\"2e-gTE0IKqsj+rNG0tojkpW/WZezTc\"",
  "timestamp": "2017-06-01T16:07:19.777Z"
}

Failed

This event indicates that the message has failed to be sent or delivered.

🚧

You only receive channel statuses for non general failures

If your message is accepted but when we try to send we have an issue and cannot send it on any of the channels requested, then you will receive a message.failed event but with no details in the channelStatus object. If we are able to submit to a channel but an issue occurs, then the channelStatus object will contain an object describing the channel issue. See the examples above.

Examples

{
    "eventId": "8270b263-4b21-4396-be5a-deb7803bbe3a",
    "accountId": 1234,
    "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.failed",
    "payload": {
        "details": {
            "reason": "The message failed because it could not be sent to any of the configured channels.",
            "channelStatus": {}
        },
        "updatedOn": "2018-06-28T09:56:17.296Z",
        "metadata": {
            "myMessageId": 45210
        },
        "id": "0c7d3c2c-c90b-4d12-8416-683420186d08"
    },
    "revision": 2,
    "etag": "\"2e-xiPUac66W8M5clJfkYKXKQ/nBR8\"",
    "timestamp": "2018-06-28T09:56:17.305Z"
}

{
    "eventId": "c14320d9-6f24-48c6-a981-15879b756203",
    "accountId": 1234,
    "apiSpaceId": "ae1f5482-2438-41ce-ac1a-9137491f701d",
    "name": "message.failed",
    "payload": {
        "id": "37fe6fcc-8149-48d0-baf9-1c72850d532b",
        "details": {
            "channelStatus": {
                "sms": {
                    "status": "failed",
                    "details": {
                        "reason": "Rejected by operator",
                        "data": {
                            "tranid": "78303243",
                            "messageguid": "a88cf899-07dc-47c0-873f-f2dba2dc35f1",
                            "statusid": "4",
                            "recipient": "447123123123",
                            "statusdescription": "Messages rejected by operator",
                            "datetime": "2019-04-12T10:47:00.237",
                            "clientref": "37fe6fcc-8149-48d0-baf9-1c72850d532b",
                            "submissiontime": "2019-04-12T10:41:13.073",
                            "apispaceid": "AE1F5482-2438-41CE-AC1A-9137491F701D",
                            "statustimeutc": "2019-04-12T09:46:00.000Z"
                        }
                    },
                    "updatedOn": "2019-04-12T09:46:00.000Z"
                }
            },
            "reason": "Channel reported the message was undeliverable"
        },
        "metadata": {
            "data": "My correlation data"
        },
        "updatedOn": "2019-04-12T09:46:00.000Z"
    },
    "revision": 4,
    "etag": "\"2e-9e8qfTZb9PDAQGEExbOz24FWjPk\"",
    "timestamp": "2019-04-12T09:47:00.657Z"
}

{
  "eventId": "9e33d815-3700-46fd-a9f7-97004298747d",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.failed",
  "payload": {
    "id": "8d7e7543-92e3-4acd-abfe-d527a7ea580b",
    "details": {
      "reason": "The message failed because it could not be sent to any of the configured channels.",
      "channelStatus": {
        "rcs": {
          "status": "failed",
          "updatedOn": "2019-10-24T13:31:11.619Z",
          "details": {
            "reason": "The profile is not tester",
            "data": {
              "phoneNumber": "447123123123",
              "phoneNumberCountryCode": "GB",
              "profileId": "e9395e29-a4b8-4d4c-9ea1-f6e1a676ac62"
            }
          }
        }
      }
    },
    "metadata": {
      "data": "My important data"
    },
    "updatedOn": "2019-10-24T13:31:11.619Z"
  },
  "revision": 2,
  "etag": "\"2e-7KQ6HOIk/Wlv5NWBmcEYBa9ZL+s\"",
  "timestamp": "2019-10-24T13:31:11.633Z"
}

{
  "eventId": "d8536261-ee1d-4b88-8f2e-89d9ea35dd1b",
  "accountId": 1234,
  "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
  "name": "message.failed",
  "payload": {
    "details": {
      "reason": "The message failed because it could not be sent to any of the configured channels.",
      "channelStatus": {
        "fbMessenger": {
          "status": "failed",
          "details": {
            "reason": "connect ETIMEDOUT 31.13.71.1:443"
          },
          "updatedOn": "2017-08-31T11:13:38.238Z"
        }
      }
    },
    "updatedOn": "2017-08-31T11:13:38.239Z",
    "id": "2a680295-581f-41a7-8825-c6d488e87d07"
  },
  "revision": 2,
  "etag": "\"2e-X5EBTbPlzb3vKVB3mCNjthHMD2E\"",
  "timestamp": "2017-08-31T11:13:37.895Z"
}

Inbound

This event is an inbound message from a channel.

Examples

{
  "eventId": "0028ebc3-c0e9-4924-9b44-9135c7990f57",
  "accountId": 1234,
  "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447234234234",
      "profileId": "sms_447234234234"
    },
    "channel": "sms",
    "to": {
      "phoneNumber": "447123123123"
    },
    "body": "Hello",
    "channelData": {
      "messageId": "2014753436",
      "keyword": "",
      "clientRef": "",
      "receivedOn": "2017-08-31T11:57:54.000Z"
    },
    "id": "4980e512-1a11-4ac3-ad9b-f8a23905432b",
    "receivedOn": "2017-08-31T11:57:55.735Z"
  },
  "revision": 0,
  "etag": "\"2e-egLNsnrQHYwEYFdCSTKKvFzExjM\"",
  "timestamp": "2017-08-31T11:57:55.738Z"
}

{
  "eventId": "020b8e91-a116-47c6-b7e9-dab878e5761a",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "fbMessengerId": "1924625277645988",
      "profileId": "[email protected]"
    },
    "channel": "fbMessenger",
    "body": "Hi there",
    "channelData": {
      "pageId": "118143536805220",
      "body": {
        "sender": {
          "id": "1924625277645988"
        },
        "recipient": {
          "id": "118143536805220"
        },
        "timestamp": 1496157103192,
        "message": {
          "mid": "mid.$cAAAnV7v5AVdiiy7sWFcWemjwmFUt",
          "seq": 611,
          "text": "Hi there"
        }
      }
    },
    "id": "8e14bc40-cf93-44bf-be7b-d5dfa77cb53e",
    "receivedOn": "2017-05-30T15:11:44.451Z"
  },
  "revision": 0,
  "etag": "\"2e-gLoREj4XI35uB44EZ2pYIeiIhls\"",
  "timestamp": "2017-05-30T15:11:45.169Z"
}

{
  "eventId": "bb7529b7-6f42-48ae-9c7c-f4787f0309c1",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "fbMessengerId": "1924625277645988",
      "profileId": "[email protected]"
    },
    "channel": "fbMessenger",
    "channelData": {
      "pageId": "118143536805220",
      "body": {
        "sender": {
          "id": "1924625277645988"
        },
        "recipient": {
          "id": "118143536805220"
        },
        "timestamp": 1496157323290,
        "message": {
          "mid": "mid.$cAAAnV7v5AVdiizJIGlcWez6SN4a6",
          "seq": 613,
          "attachments": [
            {
              "type": "image",
              "payload": {
                "url": "https://scontent.xx.fbcdn.net/v/t35.0-12/18836412_972877662815683_1343824608_o.png?_nc_ad=z-m&oh=bb64923a45848c937f15cbb415bf7942&oe=592F8F05"
              }
            }
          ]
        }
      }
    },
    "id": "2e779cb8-681d-440f-b48a-c0e6061cecc0",
    "receivedOn": "2017-05-30T15:15:32.120Z"
  },
  "revision": 0,
  "etag": "\"2e-JpSAWx+NJaPfrFzaDVTp863rgZ4\"",
  "timestamp": "2017-05-30T15:15:32.873Z"
}

{
    "eventId": "aedd9b12-b58e-484f-ab56-a2f6f78436d5",
    "accountId": 1234,
    "apiSpaceId": "fe42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.inbound",
    "payload": {
        "from": {
            "twitterId": "812306064336760832",
            "twitterUsername": "JBloggs",
            "twitter": {
                "created_timestamp": "2590-01-15T00:38:52.000Z",
                "name": "Joe Blogs",
                "profile_image_url_https": "https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png",
                "protected": false,
                "verified": false
            },
            "profileId": "d377e8b2-5926-4a1b-b5c4-9ae200cae6b6"
        },
        "channel": "twitterDm",
        "to": {
            "twitterId": "845311511659708416"
        },
        "messageParts": [
            {
                "type": "text/plain",
                "data": "Blue Bird"
            }
        ],
        "channelData": {
            "body": {
                "data": {
                    "type": "message_create",
                    "id": "1047039859041423364",
                    "created_timestamp": "1538468730112",
                    "message_create": {
                        "target": {
                            "recipient_id": "845311511659708416"
                        },
                        "sender_id": "812306064336760832",
                        "message_data": {
                            "text": "Blue Bird",
                            "entities": {
                                "hashtags": [],
                                "symbols": [],
                                "user_mentions": [],
                                "urls": []
                            },
                            "quick_reply_response": {
                                "type": "options",
                                "metadata": "external_id_2"
                            }
                        }
                    }
                },
                "user": {
                    "id": "812306064336760832",
                    "created_timestamp": "1500385225907",
                    "name": "Joe Blogs",
                    "screen_name": "JBlogs",
                    "protected": false,
                    "verified": false,
                    "followers_count": 1,
                    "friends_count": 12,
                    "statuses_count": 0,
                    "profile_image_url": "http://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png",
                    "profile_image_url_https": "https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png"
                }
            }
        },
        "receivedOn": "2018-10-02T08:25:30.747Z",
        "body": "Blue Bird",
        "correlation": {
            "messageId": "372bbfb8-4d8e-46f1-b8d2-b33a762171c9"
        },
        "id": "78aae0cb-bdca-4b79-9f73-83dcb2851c89"
    },
    "revision": 0,
    "etag": "\"2e-EKGW6fs2r7aKY00i++n2W/ydqRM\"",
    "timestamp": "2018-10-02T08:25:30.749Z"
}

{
    "eventId": "024c3f39-86a9-47a8-b3b9-7a1fc3e273e3",
    "accountId": 1234,
    "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.inbound",
    "payload": {
        "from": {
            "profileId": "anon_4c191a33-050b-4bab-9147-38300445fdd4"
        },
        "to": {
            "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
            "profileId": "TEAM\\Customer_Services"
        },
        "channel": "appMessaging",
        "channelData": {
            "messageId": "36136f57-7c13-4a6b-bc17-67f5c4dfd201",
            "metadata": {},
            "context": {
                "from": {
                    "id": "anon_4c191a33-050b-4bab-9147-38300445fdd4"
                },
                "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "sentBy": "session:anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "sentOn": "2019-03-07T10:40:49.118Z",
                "scope": "a2p",
                "direction": "inbound"
            },
            "parts": [
                {
                    "data": "Hi there",
                    "size": 8,
                    "type": "text/plain"
                }
            ]
        },
        "body": "Hi there",
        "correlation": {
            "messageId": "8b6076fe-4c85-4f92-a195-3625a7a62c32"
        },
        "id": "13a4090d-59f5-4f5f-8b5c-44904e4f33cd",
        "receivedOn": "2019-03-07T10:41:16.184Z"
    },
    "revision": 0,
    "etag": "\"2e-XQsB+++7ler4ZxAAPBVKJ1apYKs\"",
    "timestamp": "2019-03-07T10:41:16.193Z"
}

{
  "eventId": "833b5df1-7238-4916-bd2d-5ef0ebf24d61",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447123123123",
      "phoneNumberCountryCode": "GB",
      "profileId": "98f16701-7041-4511-b0ab-34a4554599de"
    },
    "channel": "rcs",
    "to": {
      "agentId": "770950354877"
    },
    "messageParts": [
      {
        "type": "text/plain",
        "data": "Hi"
      }
    ],
    "receivedOn": "2019-10-24T13:46:55.502Z",
    "body": "Hi",
    "correlation": {
      "messageId": "eeabef3f-848d-4a00-8aaa-c7779648d7e5",
      "metadata": {
        "data": "My important data"
      }
    },
    "id": "5f111b34-b9c8-483f-afa2-eeeed6346366"
  },
  "revision": 0,
  "etag": "\"2e-82hH53sJtouGf0qQqqxl6xNQwS0\"",
  "timestamp": "2019-10-24T13:46:55.531Z"
}

{
  "eventId": "1c26007e-7e3a-4c2e-a6ef-5c8a8d7b4d94",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447123123123",
      "phoneNumberCountryCode": "GB",
      "profileId": "98f16701-7041-4511-b0ab-34a4554599de"
    },
    "channel": "rcs",
    "to": {
      "agentId": "770950354877"
    },
    "messageParts": [
      {
        "type": "application/pdf",
        "url": "https://rcs-user-content-eu.storage.googleapis.com/802acc59-605f-417c-c2fb-877222c2d1e7/5f5cd9e112c64f47aa79368b945643b3e4ef51021d739db15d07cbcfacc5",
        "name": "ClaimsForm.pdf"
      }
    ],
    "receivedOn": "2019-10-29T16:38:46.405Z",
    "correlation": {
      "messageId": "419b23d5-8e82-4b05-9a30-b2d91400033d",
      "metadata": {
        "data": "My important data"
      }
    },
    "id": "1be3b3cf-e93e-4b81-97ca-2b747ec2a8ff"
  },
  "revision": 0,
  "etag": "\"2e-Kf5vZlGmG20yIO7oPsDxEPZUiW8\"",
  "timestamp": "2019-10-29T16:38:46.428Z"
}

{
  "eventId": "d40f6c64-2687-40db-8315-b2a7c486cb6b",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447123123123",
      "phoneNumberCountryCode": "GB",
      "profileId": "98f16701-7041-4511-b0ab-34a4554599de"
    },
    "channel": "rcs",
    "to": {
      "agentId": "770950354877"
    },
    "messageParts": [
      {
        "type": "image/gif",
        "url": "https://rcs-user-content-eu.storage.googleapis.com/403705b0-5638-45d3-91a7-cd2d3cbadfe7/8b4c1b0f711bbbc4fe07b751edb494ef09c00f7b21f5ba83015d25e6ca23",
        "name": "3"
      }
    ],
    "receivedOn": "2019-10-29T16:21:06.195Z",
    "correlation": {
      "messageId": "419b23d5-8e82-4b05-9a30-b2d91400033d",
      "metadata": {
        "data": "My important data"
      }
    },
    "id": "7ba338db-fb7c-46ed-8d45-ffab38a5c5c6"
  },
  "revision": 0,
  "etag": "\"2e-eiv0ZMO6mzU2sO0z3TL69n1ux2E\"",
  "timestamp": "2019-10-29T16:21:06.197Z"
}

{
    "eventId": "69402c9c-672d-41fb-9e9d-7512f0b83a71",
    "accountId": 1234,
    "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.inbound",
    "payload": {
        "from": {
            "phoneNumber": "447123123123",
            "whatsApp": {
                "whatsAppId": "447123123123",
                "name": "Tom Smith"
            },
            "phoneNumberCountryCode": "GB",
            "profileId": "anon_7b1302b0-4433-439e-bfb2-94e5daf21f9c"
        },
        "channel": "whatsApp",
        "to": {
            "phoneNumber": "447700600000"
        },
        "messageParts": [
            {
                "type": "text/plain",
                "data": "Hello from WhatsApp"
            }
        ],
        "receivedOn": "2020-11-26T14:07:41.207Z",
        "body": "Hello from WhatsApp",
        "correlation": {
            "messageId": "85bf4ea4-8791-4c97-b9c5-4922f66c4b6f"
        },
        "id": "ef2a5dfa-c2be-4d15-8b8f-d0300c2963eb"
    },
    "revision": 0,
    "etag": "\"2e-O2FOl5l5KMNYVNRY9UftEqTq7cg\"",
    "timestamp": "2020-11-26T14:07:41.209Z"
}

{
    "eventId": "7b114275-7c29-4446-9a70-75c7d63b5eb0",
    "accountId": 1234,
    "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.inbound",
    "payload": {
        "from": {
            "phoneNumber": "447123123123",
            "whatsApp": {
                "whatsAppId": "447123123123",
                "name": "Tom Smith"
            },
            "phoneNumberCountryCode": "GB",
            "profileId": "anon_7b1302b0-4433-439e-bfb2-94e5daf21f9c"
        },
        "channel": "whatsApp",
        "to": {
            "phoneNumber": "447700600000"
        },
        "messageParts": [
            {
                "url": "https://content-cpaas.dotdigital.com/apispaces/61d1780d-8440-480a-b268-20b1eb50a4ff/content/b30e4c1b-f1e3-4732-871a-5448105e4459",
                "type": "image/jpeg",
                "size": 433081
            }
        ],
        "receivedOn": "2020-11-26T14:06:47.017Z",
        "correlation": {
            "messageId": "85bf4ea4-8791-4c97-b9c5-4922f66c4b6f"
            }
        },
        "id": "17d4d626-5ecf-425e-bcd5-b06ec69059ea"
    },
    "revision": 0,
    "etag": "\"2e-jml3dXIWbyN3/zVVni/owGx71bQ\"",
    "timestamp": "2020-11-26T14:06:47.018Z"
}