Custom conversation banners

Custom conversation banners allow you to provide agents with information relevant to specific type of conversation. If custom conversation banners are enabled on a conversation template, the banner appears at the top of the conversation tab in the Agent Desk for every conversation based on that template.

Configuration

To display a custom conversation banner, you must configure the conversation template in question accordingly.

Set com.unblu.conversation.ui.showCustomConversationBanner to true.
Define the notification level of the banner with the configuration property com.unblu.conversation.ui.customConversationBannerNotificationLevel. This determines the color of the banner and the icon that appears to the left of the text.

The colors and icons used are the ones defined in the configuration properties for announcement, error, neutral, success, and warning messages. For more information, refer to the Colors section of the UI theming cheat sheet.
The text for the custom conversation banner is defined in the text property com.unblu.conversation.ui.customConversationBannerText.

You can style the text with Markdown and provide translations of the text for different languages.

Creating custom conversation banners with the Unblu web API

Custom conversation banners are defined by configuration and text properties. As a result, creating or modifying them with the Unblu web API is a matter of passing values for the relevant configuration or text properties when creating or updating the conversation template or conversation.

For example, suppose your organizations relationship managers have long-running conversations with their clients. If you want to display a custom conversation banner in one of these conversations, you can call /conversations/{conversationId}/updateConfiguration to enable the custom conversation banner and /conversations/{conversationId}/updateText to add the text.

You can use the web API to set and modify the conversation banner dynamically. Changes you make are displayed in the Agent Desk in real time.

For more information, refer to the Unblu web API reference.