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 Contact Center as a Service
- Bring Your Own Channel for Messaging
This API is available in version 62.0 and later.
v1/acknowledgement
POST
Format: Bearer <Salesforce Access Token>
String. Standard header. Used to authenticate the user, where <Salesforce Access Token> is the Salesforce access token used as the bearer token to make requests to the Interaction Service APIs. Required.
Format: application/json
String. Standard header. Format of the request payload. Required for any request that includes a body.
Format: <Salesforce Org ID>
String. Custom header. The Salesforce org. <Salesforce Org ID> is the 15-character Org ID of the Salesforce org. Required.
Format: <UUID>
String. Custom header. Universally Unique Identifier (<UUID>) that references and tracks this request. Required.
Format: <AuthorizationContext>
String. Custom header. Additional information for the request authorization used to authenticate and validate requests against the connected app scopes.
- For Bring Your Own Channel for CCaaS, set
<AuthorizationContext>to the developer name of the ConversationChannelDefinition record. For example, Partner1_ChannelDefinition1. Required. - For Bring Your Own Channel for Messaging, set
<AuthorizationContext>to the developer name of the ConversationChannelDefinition record. For example, Partner1_ChannelDefinition1. Required.
| 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 |