Inbound open receipt messages

To send an inbound open receipt message conversation, use the API:

Information about the request payload and response can be found there.

There are 2 supported receipt statuses for this endpoint: Delivered | Failed

To send an inbound receipt for an outbound message, please replace the {integrationId} above with the integration id of your integration. For instance, if your integration id is c6b0e62f-8487-44fd-a218-c16e006a7a23, your endpoint will look like the following: POST /api/v2/conversations/messages/c6b0e62f-8487-44fd-a218-c16e006a7a23/inbound/open/receipt.

This example is an inbound receipt for an outbound message. For more information on receipts see Message receipts

The below payload shows an example of a successfully delivered inbound receipt for an outbound message.

{
  "id": "<Original Messaging Platform Message ID>",
  "channel": {
    "to": {
      "id": "messaging-user@externalservice.com",
      "idType": "email"
    },
    "time": "2023-01-21T16:47:08.592Z"
  },
  "status": "Delivered",
  "direction": "Outbound"
  "isFinalReceipt":true
}

Messages could fail for any number of reasons. In these situations, we retry sending messages, but if a message cannot be sent, we generate a failure receipt and send it to the message's sender.

The following example shows how a failure receipt appears for inbound receipt for direction Outbound.

{
  "id": "<Original Messaging Platform Message ID>",
  "channel": {
    "to": {
      "id": <Original Message to id>,
      "idType": "<Original Message idType>"
    },
    "time": "2023-01-21T16:47:08.592Z"
  },
  "status": "Failed",
  "direction": "Outbound"
  "isFinalReceipt":true,
  "reasons":[
      {
         "code":"GeneralError",
         "message":"<message associated with the failure>"
      }
   ]
}