Send Delivery Acknowledgments or Read Receipts
Sends “Delivered” or “Read” acknowledgments so that reps know when outbound messages have been delivered or read by the message recipient.
This API marks a conversation entry as “Delivered” after the message reaches the message recipient or “Read” after the message recipient reads the message.
Each request can support up to 25 delivery and read acknowledgments. If the request includes multiple acknowledgments, the last message received based on the acknowledgements.acknowledgementTimestamp value will be marked.
This API applies to the following products:
- Bring Your Own Channel for Messaging
- Bring Your Own Channel for Contact Center as a Service
This API is available in version 62.0 and later.
v1/acknowledgement
POST
Authorization: Bearer <Salesforce access token>
String. Standard header. The authorization token, where \<token\> is the JSON Web Token (JWT). Required.
Content-Type: <Request body format>
String. Standard header. The format of the request body. Valid format is multipart/form-data. Required.
OrgId: <Salesforce Org Id>
String. Standard header. The 15-character Org ID of the Salesforce org. Required.
AuthorizationContext: <ConversationChannel Definition developer name>
String. Standard header. The ConversationChannelDefinition developer name in the format {prefix}_{ConversationChannelDefinitionName}. The prefix must match the developer name prefix of the corresponding connected app. For example, Partner1_ChannelDefinition1. Required.
RequestId: <GUID>
String. Standard header. A globally unique ID (GUID). Required.
For example,
| Property Name | Type | Description | Required |
|---|---|---|---|
| sender | object | An object representing a messaging participant. The participant can be a rep or end user. | Yes |
| sender.appType | string | The app type used for the conversation. Set this value to custom to represent a custom channel. | Yes |
| sender.subject | string | The end user client identifier. | Yes |
| sender.role | string | The role within the conversation. Set this value to EndUser. | Yes |
| conversationIdentifier | string | The unique ID for the conversation channel. | Yes |
| acknowledgements | string | A list of delivery acknowledgments and read receipts, sorted in chronological descending order by acknowledgements.acknowledgementTimestamp. Each request can support up to 25 delivery and read acknowledgments. If multiple outbound messages are sent, the rep sees the last acknowledgment in the list. | Yes |
| acknowledgements.acknowledgementTimestamp | int64 | The date and time of the delivery acknowledgment or read receipt. | Yes |
| acknowledgements.acknowledgementType | string | The type of acknowledgment. Valid values are delivery for delivery acknowledgments, and read for read receipts. | Yes |
| acknowledgements.acknowledgedConversationEntryIdentifier | string | The unique identifier for the conversation entry that’s associated with the acknowledgment. | Yes |