message
A message identifier you provide in a real-time response to your Get Retention Message endpoint.
Declaration
object messageProperties
| Name | Type | Description |
|---|---|---|
messageIdentifier | messageIdentifier | The identifier of the message to display to the customer. |
Discussion
In your RealtimeResponseBody real-time response, you can choose from mutually exclusive options. Include message in your response to provide a text-based message (with or without an image) as the retention message the system displays to the customer.
The message identifier needs to refer to a message that has a messageState of APPROVED; otherwise, the retention message fails. If the message includes an image, the image also needs to have an imageState of APPROVED. For more information about setting up messages, see Setting up retention messages.