Kustomer Chat SDKs

The Kustomer Chat SDK is available for Android, iOS, and web

Android

12 days ago by [email protected]

v2.9.1

Release date: 10-11-2021 // Docs (latest)

Summary: Hotfix release

Fixed

  • Fixed a bug where users restricted to one open chat would not see the New Conversation button if they had conversations that were merged but not closed.

Update

  • We have temporarily locked the screen orientation to Portrait mode while we work on improving rotation and better handling of configuration changes.

v2.9.0

Release date: 09-23-2021 // Docs (deprecated)

Fixed

  • Fixed a bug that causes CSAT message labels to overlap. Now, labels that are over 25 characters long are shown in full or truncated with an ellipses.
  • Fixed a bug where the Search icon in an article wasn’t responsive. Now, you can use this icon to search articles.

Added

  • Added pagination to the conversation list to increase page loading speed. The first 100 conversations are shown on the first page.

Improved

  • Improved how videos display in the chat UI. Now, if you select a video link in an article, the full video plays.
  • Improved the speed and reliability of message delivery.
  • Messages created over 30 days ago are now retained.

v.2.8.1

Release date: 08-20-21

Fixed

  • Fixed a bug that causes conversations marked Done in Kustomer to be displayed in the conversation list despite Hide History being set to true.
  • Fixed a bug that causes images to overlap with text on small screens.
  • Fixed a bug that causes the app to crash if internet connection is lost.
  • Fixed an issue with user initials in an avatar being off-center.

v.2.8.0

Release date: 08-05-21

🚧

Previous theme no longer supported

The KusAppTheme that was previously used customize chat UI colors colors is no longer supported. We recommend you use the updated Color customization guide, or change your existing style name from

<style name="KusAppTheme" parent="Theme.MaterialComponents.DayNight.NoActionBar">

to

<style name="KusAppTheme.Overlay" parent="KusAppTheme">

The rest of the styling can stay the same. If you're overriding any colors in the UI SDK, please review our updated Color customization guide for any changes that might affect you.

Fixed

  • Fixed a bug that causes images to overlap text.
  • Fixed a bug occurring on some devices that caused the text box to have to be re-selected in between messages.

Added

  • Added support for Android 12. You can read more information on how Android 12 may affect your app behavior here.
  • Added a new openKbArticle method that can be used to open a Knowledge base article by its ID.
  • Added a new method that can be used to determine when to call login. For more information, see Log in and authentication.
  • Added more informative error messages for scenarios where chat cannot initialize due to required chat settings that may be missing.
  • Added additional color customization options. To learn more, see the updated Color customization guide.

Improved

  • Improved the keyboard behavior when filling out a CSAT. The keyboard now automatically collapses if the user is interacting with a non-text component.
  • Improved the French and Spanish translations in buttons and tabs.

v.2.7.1

Release date: 07-09-2021

Fixed

  • Fixed a bug impacting the Powered by Kustomer logo.

Added

  • Added a brandOverride method to Kustomer Core that relies on a callback instead of Kotlin Coroutines.

v2.7.0

Release date: 06-30-2021

Fixed

  • Fixed a bug that caused an empty chat bubble to appear after replying with an image that has a new line inserted after the image.
  • Fixed a bug that caused a no network connection screen to appear when viewing empty knowledge base articles.
  • Fixed a bug where chatSettings may not be initialized by the time they are required to display the chat UI.
  • Fixed a bug where the CSAT unread count badge isn’t showing when viewing the conversation list view.

Added

  • Added a new hideHistoryNavigation configuration option to hide the back button in the Conversations view. Use this configuration option to allow customers to have multiple chats open at the same time and bypass the Conversations (chat history) view when appropriate.
  • Added the option to open a help article in your device browser. Previously, articles could only be viewed in the Knowledge Base view of the chat widget. You can hide the ability to open help articles in a browser by using the new hideKbArticleShare configuration option. For more information, see the KustomerOptions class reference.
  • Added the overrideAssistant and overrideBrand parameters. For more information, see Open the Chat UI with overrides.

v.2.6.2

Release date: 06-09-2021

Fixed

  • Fixed a bug that caused errors in how conditional branching for the conversational assistant handled multi-level list values.
  • Fixed a bug that caused the SDK to create draft conversations in the customer timeline. To fix this issue, we updated the SDK to use the latest chat session POST endpoint, updated from /c/v2.0/chat/session to /c/v2.1/chat/session.

Improved

  • Improved the visual consistency for avatar display in the chat UI across all conversations.
  • Improved message loading for users when they open the SDK without a network connection. Now, messages display inside existing conversations even after users open the SDK without a network connection.

v.2.6.1

Release date: 05-27-2021

Summary: We made several updates and bug fixes to the Chat Android SDK with a focus on the following:

  • Improve render performance
  • Improve user experience for the chat UI
  • Add attachment upload functionality for all conversations
  • Add text copy functionality for chat bubbles

Fixed

  • Fixed a bug that caused the chat widget to display a “New Conversation” button in the Conversations view when a customer ends a conversation and the chat widget is set to appear offline. Now, the chat widget displays a “Leave a message” button as expected.
  • Fixed a bug that caused SDK strings to display in English instead of the default device language when an explicit SDK language override was undefined.
  • Fixed a bug that caused formatting errors for some hyperlinked text in the UI. Now, all hyperlinked text appears as clickable text in the UI as expected.
  • Fixed an edge-case bug related to NullPointerException for getBitmap from a URI.

Added

  • Added functionality for users to add attachments to new conversations with or without conversational assistants to match functionality with the Chat Web SDK.
  • Added functionality for users to tap and hold chat bubbles to copy the message text to their clipboard.
  • Added handling for multiple taps for conversational assistant button responses. Now, response buttons are hidden after the first tap to prevent multiple taps.

Improved

  • Improved the keyboard display behavior to always minimize the keyboard when a customer returns to the Conversations view from an open conversation.
  • Improved the overall render performance for the Chat Android SDK with an emphasis on view rendering performance improvements.

v.2.6.0

Release date: 05-14-2021

Summary: We made several updates and bug fixes to the Chat Android SDK with a focus on the following:

  • Improve consistency and usability for chat widget display behavior, UI copy, message previews, and merged conversations.
  • Improve consistency of language locale overrides set in the SDK.
  • Remove an unnecessary default declaration from the SDK manifest file.

Docs: We added a new developer guide: Quick start: Chat SDK for Android 🎉.

Fixed

  • Fixed several small memory leaks where references to views were retained beyond their lifetime.
  • Fixed a bug that caused message loading errors for some users when refreshing newly created conversations with the “pull to refresh” gesture.
  • Fixed a bug that caused the chat widget to display “Chat has ended” for some users when they tried to create a new conversation after a conversation has ended by tapping the New Conversation button.

Improved

  • Improved the Conversations list UI to display different message previews based on the last message. Now, the Conversations list UI displays the following:
    • If the user sent an image as the last message: “You sent an attachment”
    • If the agent sent an attachment as the last message: the required body text that was sent with the attachment
    • If the conversational assistant sent order results from the Object Selector dialog as the last message: the message text the assistant sent before the results
  • Improved the UI copy for consistency with other mobile and web Chat SDKs. Now, button text in the Android SDK uses title case and matches the button text casing for other Chat SDKs.
  • Improved the user experience for conversations merged by an agent. Previously, the SDK opened a new conversation for a user after a merge. Now, the SDK opens the user to the destination conversation after an agent merge.
  • Improved the display for truncated titles and descriptions for KObjects sent through the Object selector dialog feature for the conversational assistant. Now, truncated KObject titles or descriptions appear with ellipses in the UI.
  • Improved the keyboard display behavior in the Knowledge Base view for the chat widget. Now, the keyboard display remains closed when there are no results after an article search in the Knowledge Base view.
  • Improved the usability of the Conversations list for organizations to match the Chat Web SDK behavior for closed conversations. Now, the Android SDK displays in the Conversations list the name of the last agent, conversational assistant, or the team a customer received a message from before the conversation was closed.
  • Improved the consistency of language locale overrides set in the SDK.
  • Improved the display behavior for avatars. Previously, the chat widget displayed a blank avatar when a team avatar was set, but an avatar was missing for a conversational assistant. Now, the chat widget always displays an avatar with the initials of the display name as a default when an avatar is unavailable.

Removed

  • Removed the following default declaration from the Android Chat SDK manifest file: android:roundIcon="@mipmap/ic_launcher_round". Previously, the SDK applied the roundIcon declaration by default when the attribute was undefined in client apps.

v2.5.0

Release date: 04-16-2021

📘

Android Chat SDK hosting is moving fully to the Maven Central Repository

JFrog will sunset Bintray and JCenter on May 1st, 2021. In response, we are now hosting the Android Kustomer Chat SDK on the Maven Central Repository.

If you've used our Bintray repositories in the past, remove the following Bintray URL from your root-level repositories container: 'https://kustomer.bintray.com/android'.

All previous versions of the Android Chat SDK are available on both Maven and Bintray until further notice."

Summary: We made several updates and bug fixes to the Chat Android SDK with a focus on the following:

  • Improve error handling, localization, and user experience for the conversational assistant and for ended conversations.
  • Add support for the Object Selector dialog interaction, a new feature for the conversational assistant.

Fixed

  • Fixed a bug that caused localization inconsistencies for some message types.
  • Fixed a bug that caused the Powered by Kustomer logo to overlap the final article listed in the Knowledge Base chat widget experience display.

Added

Improved

  • Improved the UI copy for consistency with other mobile and web Chat SDKs. Now, an “Ended” label appears for all closed conversations listed in the Kustomer Chat Conversations views.

v2.4.1

Release date: 03-29-2021

Fixed

  • Fixed the back stack handling for when users open a push notification and then go back or minimize the app. A previous bug caused some apps to close in these scenarios.
  • Fixed a bug that caused some apps to crash when a TrackingToken was not available from the network.
  • Fixed a bug that caused conversation list timestamps for the last message sent to update only when an agent sends a message. Now, the timestamps update as expected when both agent and customer messages are sent.
  • Fixed a bug that caused special characters (for example, apostrophes) in Knowledge Base articles to display improperly for the Knowledge Base chat widget experience.

Added

  • Added a Boolean return type to onMessageReceived to improve app handling for remote messages. You can now call onMessageReceived to verify first if a push notification is from Kustomer. To learn more, see Push Notifications with FCM.

Improved

  • Improved the consistency for the “New Conversation” button behavior when conversations are ended or connection is lost.
  • Improved intermittent network handling for chat messages. When a lost connection is restored, the Chat SDK 1) removes any failed message, 2) ends the conversation (if the agent has ended the conversation), and 3) displays a “New Conversation” button or CSAT survey (if applicable).
  • Improved Chat Android SDK handling for any server downtimes from either PubNub or Kustomer.

v2.4.0

Release date: 03-03-2021

Fixed

  • Fixed a bug that caused some conversational assistant messages to appear in an order different from the order expected from the assistant logic flow.
  • Fixed a bug that prevented the chat reply time, or wait message, set in Chat Management: Design settings from displaying as expected on Android devices.
  • Fixed a bug that caused chat to stop responding on Moto Z² Force devices. Previously, the squared symbol, ², in the device name created errors during network requests.

Improved

  • Improved Android Chat SDK error logs to print stack traces by default. Now, you can view stack traces in your error logs without having to turn on debug logging manually.
  • Improved error messaging and user experience for connectivity issues. Chat now displays a “No internet connection” screen when an internet connection is unavailable. We also added automatic network connection retry logic so that chat will automatically try to reconnect with a network.
  • Updated offline behavior of the “New Conversation” button. The Android SDK now turns off and hides this button for the Conversations chat history view whenever chat is offline.
  • Updated file attachment button enablement for conversational assistant flows as default. The file attachment button now appears for users during the assistant flow. Previously, the SDK delayed button enablement between when a conversation with an assistant ends and a conversation with an agent begins.

Removed

  • Removed explicit dependency on com.squareup.okhttp3:logging-interceptor to avoid dependency conflicts.

v2.3.0

Release date: 02-17-2021

Fixed

  • We fixed a bug that caused a border to appear around chat avatar icons.

Added

  • You can now specify a brandId to associate newly-created conversations with a specific brand. If you do not specify a brandId, newly-created conversations are associated with your default brand set in Kustomer.

Improved

  • You can now call the logOut API from the Background thread.
  • We removed access to internal SDK classes.

v2.2.1

Release date: 02-10-2021

Fixed

  • Assistant avatar not shown for the first message
  • Merged conversations showing in the chat history list
  • observeActiveConversationIds() API now returns conversation ids older than 30 days

Improved

  • Upgraded Kotlin version to 1.4

v.2.2.0

Release date: 01-22-2021

Fixed

  • Crash with Illegal State Exception onSaveInstanceState
  • Crash with Pubnub methodNotFound exception

Added

  • Handle conversation merge events
  • Indicate user presence state
  • Error message when a blank chat view is shown
  • Support KnowledgeBase IDs for message template articles

Improved

  • Updated German translations

v2.1.0

Release date: 01-08-2021

Fixed

  • Crash on network connectivity issue with pubnub
  • Gradle build error on Windows machine
  • Handle Glide exception when fetching agent avatar in push notifications
  • CSAT push notification shown for current active chat

Added

  • Allow optional Brand ID to fetch brand-specific settings

Improved

  • Describe conversation API to support Date formats
  • Describe customer API to support multiple input formats
  • Improved UX for submitting Customer Satisfaction surveys

Removed

  • Lowercase conversation within Describe conversation API. For Customers using Tree or Multi level list while describing conversation/customer would have to convert the values to lowercase while passing to the SDK. Please refer here for more details

v2.0.4

Release date: 12-16-2020

Fixed

  • Describe Conversation to allow boolean type
  • Show push notification for current active chat when in background
  • Images sent as user show up in Kustomer in the wrong orientation
  • Handling FCM exceptions in SDK
  • Blank push notifications
  • Showing agent gravatars

Added

  • Hide new conversation override configuration in SDK

v2.0.3

Release date: 12-07-2020

Fixed

  • Crash on CSAT using proguard
  • Crash on Push notification with an Agent avatar image

Added

  • Assistant avatar
  • Hiding of Kustomer branding via chat settings

Removed

  • Read external storage permission for uploading chat attachments

v2.0.2

Release date: 11-19-2020

Added

  • Overriding of Business schedule id after init API

Improved

  • Renamed Chat input view
  • Upgraded pubnub library to kotlin version