Kustomer Chat SDKs

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

iOS

a day ago by [email protected]

v2.5.0

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

🚧

Deprecated methods

The following methods have been deprecated. Please upgrade your implementation to iOS v2.5.0:

Fixed

  • Fixed a bug where the most relevant article search results were appearing at the bottom of the list.
  • Fixed a bug that caused the greeting image to appear in existing conversations.
  • Fixed a bug where long names used on buttons in the Button Questions interaction stretched beyond the device’s view. Now, these names are truncated or wrapped.
  • Fixed a periodic crash by updating the Alamofire library to the newest version.

Added

Improved

  • Improved the user experience and error handling of the knowledge base UI.

v2.4.11

Release date: 10-08-2021 // Docs (deprecated)

Summary: Hotfix release (Intermittent crash on iOS 15+)

Fixed

  • Fixed issue where the SDK would crash for some customers on iOS 15+.

v2.4.10

Release date: 09-23-2021

Summary: Hotfix release (Supports Xcode 12)

Fixed

  • Fixed issue where KB articles were rendering blank.

v2.4.9

Release date: 09-23-2021

Summary: Hotfix release (Supports Xcode 13)

Fixed

  • Fixed issue where KB articles were rendering blank.

v2.4.8

Release date: 09-10-2021

Fixed

  • Fixed a bug that caused responses to the assistant prompts to appear empty and left-aligned.
  • Fixed a bug that periodically caused the assistant to send duplicate messages per interaction.
  • Fixed a bug that resulted in a 1. being inserted into a message if there was an extra space.
  • Fixed a bug that periodically caused the conversation list UI to not display properly.
  • Fixed a bug that caused outbound messages with more than one line to be aligned incorrectly.

Added

  • Added the ability to customize URL colors using messageUrlLinkOnAgentBubble and messageUrlLinkOnCustomerBubble. These were formerly named messageLinkInIncomingMessageBubble and messageLinkInOutgoingMessageBubble.

Improved

  • Improved the speed and reliability of message delivery.

v2.4.7

Release date: 08-13-2021

Fixed

  • Fixed a bug that periodically caused the SDK to not automatically fetch conversation updates when the SDK was backgrounded.
  • Fixed a bug that caused the Chat UI to not display correctly for languages that read right to left.
  • Fixed a bug that caused the agent avatar to not display when using a Gravatar URL.
  • Fixed a bug that periodically caused push notifications to not display if the user logged out and logged back in.

Improved

  • Improved French and Spanish translations for the word ‘Chat’.

v2.4.6

Release date: 8-3-2021

Added

  • Can now set a blank custom reply time message.

v2.4.5

Release date: 07-29-2021

Fixed

  • Fixed a bug that caused chat conversations that were marked Done in Kustomer still show as Open in the chat UI.
  • Fixed a bug where the font size of messages sent via the conversational assistant was appearing larger than usual in the chat UI.
  • Fixed a bug that caused read messages to appear as unread after pulling to refresh the chat UI.
  • Fixed a bug that causes conversations marked Done in Kustomer to be displayed in the conversation list despite Hide History being set to true.

Added

  • Added a new method Kustomer.isLoggedIn(userEmail: String?, userId: String?) that can be used to determine when to call login. For more information, see Log in and authentication.

v2.4.4

Release date: 07-16-2021

Fixed

  • Fixed a bug that caused the app to crash if a customer returns to a chat that they abandoned before completing all of the prompts. Now, if a customer returns to their chat, they will see that the conversation ended, as well as a button where they can leave a message.
  • Fixed a bug that caused the app to crash when using Describe Conversation.
  • Fixed a bug that caused the app to crash after upgrading to v2.4.2 on devices running iOS 11 and iOS 12.

Added

Improved

  • Improved the reliability of push notifications in the app.
  • Compressed image assets to reduce SDK package size.

v2.4.3

Release date: 07-02-2021

Fixed

  • Fix a bug that caused long chat bubbles to overlap over other messages.
  • Fixed a bug where the conversational assistant wasn’t providing a list of alternate follow up channels for agent missed chats.
  • Fixed a bug where opening an app via a notification that was previously forced closed causes the app to crash.
  • Fixed a bug where KustomerUI.Color.historyNewChatButtonText was not correctly applying the set color to the New Conversation button.

Added

  • Added the ability to customize the bottom tab icon colors for chat and knowledge base.

Improved

  • Improved push notification device registration for customers using login.

v2.4.2

Release date: 06-18-2021

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

  • Improve user experience and overall consistency for the chat UI
  • Improve user experience and overall consistency for the conversational assistant
  • Improve efficiency and performance for login with customerExists(), a new method added to replace currentCustomer() (deprecated)

Fixed

  • Fixed a bug that caused article deflection reporting errors for articles provided to customers through the conversational assistant. Now, all article deflection titles appear as expected in the Article Performance table from the Deflection report in Kustomer.
  • Fixed a bug that caused errors for some customers when they reopened an abandoned chat with a conversational assistant. Now, when a customer abandons their chat with a conversational assistant, the assistant automatically ends the conversation as expected and provides the customer with the option to leave a message or start a new conversation.
  • Fixed a bug that caused conversations from previous versions of Kustomer Chat (Chat 1.0 and earlier) to appear in Kustomer Chat 2.0. Now, only conversations from Kustomer Chat 2.0 appear in Chat 2.0 conversations.
  • 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 from /c/v2.0/chat/session to /c/v2.1/chat/session.
  • Fixed a bug to reduce NSLayoutConstraint logs emitted.
  • Fixed a bug that caused errors if logOut(...) was called while the SDK was connecting or reconnecting to the Kustomer Pub/Sub service.

Added

  • Added [customerExists()] to replace currentCustomer() and to support login efficiency and performance. To learn more, visit customerExists().
  • 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. To learn more, visit Configuration.

Improved

  • Improved support for longer article titles in article suggestions from the conversational assistant. Now, the conversational assistant displays the full article title for all article suggestions regardless of title length.
  • Improved consistency for logo display. Previously, logos appeared in grayscale for read conversations for some organizations. Now, logos appear in full color as expected regardless of the read or unread status of a conversation.

Deprecated

v2.4.1

Release date: 05-25-2021

Summary: Hotfix release

Fixed

  • Fixed a bug where the keyboard from the chat interface would persist when the chat window was closed.

v2.4.0

Release date: 05-24-2021

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

  • Improve user experience and overall consistency for the chat UI
  • Improve keyboard display behavior for the chat UI
  • Fix bug crashes related to messages sent to the conversational assistant

Fixed

  • Fixed a bug that caused the SDK to send both a push notification and a duplicate in-app notification if the user opens the app without tapping the push notification.
  • Fixed a bug that caused crashes for when messages were sent to the conversational assistant.

Added

  • Added "⚡️ by Kustomer" to display on the bottom of the Answers tab and article list page in the Knowledge Base view.
  • Added a static library version of the SDK to provide developers with additional installation options.
  • Added customer messages to the onChatMessageReceived listener to make it easier to get all messages in one listener callback.

Improved

  • Improved the overall stability of the SDK.
  • Improved the consistency of language locale overrides.
  • Improved the consistency of the display order for attachments and related messages. Now, the SDK displays the relevant message body before displaying the attachment.
  • Improved the user experience and error messaging for sending attachments. Now, the SDK displays an “Error. Tap to retry” message when attachments do not send.
    Improved the message read behavior. Now, the SDK marks messages as read when the user swipes down to close the display.
  • Improved the user experience for keyboard display in the chat widget to match the Android SDK experience. Now, the keyboard remains open in the chat.
  • Improved the iOS Chat SDK dark mode assets for the “Powered by Kustomer” brand icon and the default away image to match the display behavior in the Android Chat SDK.

Removed

  • Removed the article count for Knowledge Base article categories in the Knowledge Base view to match the UI behavior of other Kustomer Chat SDKs.

v2.3.1

Release date: 04-30-2021

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

  • Improve error handling, archive support, and UI behavior for the iOS SDK.
  • Add support for the Object Selector dialog interaction, a new feature for the conversational assistant.

Fixed

  • Fixed a bug that caused formatting errors for some hyperlinked text in the UI.

Added

Improved

  • Improved the UI behavior for consistency with other mobile and web Chat SDKs. Now, the chat UI navigation resets to display the Conversations list when a user closes and then reopens the chat widget.
  • Improved archive support.

v2.3.0

Release date: 04-23-2021

Fixed

  • Fixed a bug that caused the “Leave a message” and “New Conversation” buttons to appear cut off in the chat UI for some screens.
  • Fixed a bug that caused the conversational assistant to present more than one CSAT survey for some ended conversations.
  • Fixed a bug that prevented image thumbnails for attachments from loading properly in conversations after a customer logged out and logged in again.

Added

Improved

  • Improved the offline behavior so that customers can no longer start a new conversation until they regain network connectivity.
  • Improved the UI display for Knowledge Base article titles sent through a conversational assistant dialog. Previously, words in longer article titles would appear split between lines in the chat UI for some organizations.
  • Improved the user experience for how video or PDF attachments sent by the agent appear in the UI.
    Improved the usability of the Conversations list for organizations to match the Chat Web SDK behavior for closed conversations. Now, the iOS 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 display behavior for failed messages in closed conversations. Now, chat automatically hides failed messages for conversations after they are closed.

v2.2.1

Release date: 04-08-2021

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

  • Improve behavior, usability, and functionality for conversation merge scenarios.
  • Improve support for conversational assistants for app installation and reinstallation scenarios.
  • Improve general chat performance and stability.
  • Add developer options for CSAT animations in chat.

Fixed

  • Fixed a bug that prevented customers from replying to chats after an agent merged customer profiles.
  • Fixed a bug that prevented the chat history from displaying consistently for customers on a slow or unstable connection.
  • Fixed a bug that prevented conversational assistant buttons from displaying if a customer reinstalled the app in the middle of a conversation with an assistant.
  • Fixed a bug that prevented conversational assistants, if set, from starting new conversations after a new app installation.
  • Fixed a bug that caused chat to crash after the following error: Illegal attempt to establish a relationship 'session' between objects in different contexts.
  • Fixed a rare bug that caused chat to crash after the following error: NSInvalidArgumentException: -[__NSCFSet addObject:]: attempt to insert nil

Added

  • Added the option for developers to turn on or turn off the default CSAT animation. Previously, the CSAT animation was turned on by default. Now, the animation is turned off by default. To learn more, see KustomerOptions.

Improved

  • Improved push notification support and update/routing behavior for customer chats after an agent merges customer profiles.
  • Improved the user experience and in-app messaging for article deflection and conversation merges.
  • Improved the conversational assistant behavior to re-ask article deflection questions if a customer submits an attachment in response. Previously, the assistant waited for the customer to submit a text response.

Removed

  • Removed a duplicate BCSymbolmap file that affected manual installations of the Chat iOS SDK.

v2.1.1

Release date: 04-02-2021

Summary: This update is for our developer audience. We made two changes to how we compile the framework. There are no code or product updates for this version.

  • Enabled bitcode
  • Enabled -no-serialize-debugging-options for improved xcframework compatibility

v2.1.0

Release date: 03-24-2021

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

  • Improve chat UI usability for consistency in behavior across Android and iOS SDKs.
  • Improve support and handling for synchronous chat over unstable network connections and after logout/login events.
  • Improve behavior, usability, and functionality for conversation merge scenarios between open and ended conversations.
  • Improve conversational assistant support for agent interruption.

Fixed

  • Fixed a bug that caused chat bubbles to overlap when displayed with Chat iOS SDK v2.0.6.
  • Fixed a bug that caused customer merges to appear as a conversation merge in UI.
  • 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 caused the activity indicator (or progress spinner) in the chat UI to freeze and persist even after re-establishing a network connection.
  • Fixed a bug that caused inaccuracies in the unread message count after logout/ login. The unread message count inaccuracies meant some customers could view their chat history even with the Hide Chat History synchronous chat setting turned on.
  • Fixed a bug that prevented some push notifications from opening the corresponding conversation when tapped.

Added

  • Added support for conversational assistant interruption. The assistant buttons disappear from the UI when the agent is responding (if typing indicators are turned on) or after the agent sends a message to the customer and interrupts the assistant flow.
  • Added support for the Date data type for custom attributes on describeCurrentCustomer.

Improved

  • Improved the usability of the conversation button when the “Restrict to Single Open Chat” synchronous chat setting is turned on. To better match the actual behavior, the conversation button now displays “Return to Open Conversation” instead of “New Conversation”.
  • Improved functionality for merge scenarios between open conversations and ended conversations. Now, when an agent merges either an open conversation into an ended conversation, or an ended conversation into an open conversation, the merged conversation will display as an open conversation with the messages threaded together. A CSAT survey won’t display because the conversation is open.
  • Improved intermittent network handling.

v2.0.7

Release date: 03-01-2021

Improved

  • Improved error messaging and user experience for connectivity issues. Now, a “No internet connection” screen is displayed when an internet connection is unavailable. The screen also displays a retry button for chat and persists until a stable internet connection becomes available again.
  • Improved consistency for isChatAvailable method. Now, `isChatAvailable returns a Boolean instead of a callback. To learn more, see the updated documentation for is Chat available?.

v2.0.6

Release date: 02-10-2021

Fixed

  • Fixed issues with login
    • Image loading
    • In-app notifications
    • Reconnect button

Improved

  • Updated German Translations
  • Improved UI for Conversation Move
  • Improved push notification registration

v2.0.5

Release date: 01-28-2021

Fixed

  • Bug fix for multi-line text input not resizing as user types
  • Minor fixes and improvements to conversation and customer merging and moving

Added

Deprecated

v2.0.4

Release date: 01-12-2021

Fixed

  • Inline images displayed incorrectly in chat
  • -,*,<,> display correctly in chats

Added

  • Multi-line KB article titles
  • Added a "Thank you for your rating" pop up when completing a satisfaction survey

Improved

  • Improved KB performance
  • General performance improvements

Deprecated

  • Deprecated KustomerClient.resetTrackingToken. Use logOut instead.
  • Deprecated ChatProvider.identifyCurrentCustomer. Use logIn() or logOut() followed by logIn() instead.

v2.0.3

Release date: 12-17-2021

Fixed

  • Crash when a typing indicator signal is received while logging out

Added

  • Kustomer.rootViewController (read-only)
  • Kustomer.options.hostViewController
  • Kustomer.options.hideNewConversationButton
  • PushProvider.shared.listLivePushChannelRegistrations(completion:)
  • Additional logging at the .info level for push registration

Improved

  • Chat assistant quick replies

v2.0.2

Release date: 12-03-2020

Fixed

  • Push notification registration failure
  • iOS 11 and 12: message bubble background color always black

Added

  • Callbacks for when the Kustomer UI view controller is shown/hidden
    Added onViewDidAppear, onViewWillAppear, onViewWillDisappear, and onViewDidDisappear to KustomerOptions. Events fire when the main Kustomer UI view controller is shown/hidden
let options = KustomerOptions()

options.onViewWillAppear = { animated in
  print("view will appear")
}

Kustomer.configure(apiKey:"foo", options:options, launchOptions:launchOptions)

Improved

  • Renamed ChatProvider.shared.createConversation(title: ...) to ChatProvider.shared.createConversation(firstCustomerMessage: ...)
  • Agent name can take up multiple lines on chat detail screen