SDK Change log

Note: An SRI check is available for this SDK. For more information, see the SDK Subresource Integrity page.

Version 1.34.1 (2019.09.18)

  • Updated Hyperchat Adapter.

Version 1.34.0 (2019.09.18)

Important: In this version, the Hyperchat Adapter has a known bug where it does not retrieve the user information correctly. Inbenta recommends that you use version 1.34.1 instead.

  • Added: New onDomReady subscription. This subscription will be triggered when the HTML DOM elements have been rendered for the first time.

Version 1.33.0 (2019.09.04)

  • Added: New showActivityOnDelay configuration. This feature allows you to show a "..." waiting symbol when the Chatbot takes longer than a certain amount of time to respond. The duration of this wait time is configurable within the parameter.

Version 1.32.0 (2019.08.21)

  • Added: New labels in several languages
  • Added: We made some internal changes to optimize the recovery of timestamps. This does not affect the behaviour of the bot.

Version 1.31.0 (2019.08.07)

Version 1.30.0 (2019.07.24)

  • Added: setExternalInfo action and subscription.
  • Added: escalationStart action and subscription.
  • Added: Chatbot configuration is now available in the Chatbot instance.
  • Added: Answers with empty messageList are not filtered before the onDisplayChatbotMessage subscription, js_callback is executed if there is an empty answer.
  • Fixed: Multiple API authorization attempts after authentication has been rejected.
  • Fixed: A bug was found with the delayOnMultipleAnswers parameter that caused multiple-object answers to appear out of order when followed by dialog nodes. This is now fixed.

Version 1.29.0 (2019.07.10)

  • Added: New API Client method addMultipleVariables to set multiple variables in a single request.
  • Added: New API Client method resetVariables to reset multiple variables to their default value in a single request.
  • Fixed: Any API error could trigger SetCallbackWhenInvalidAccessToken. This is now fixed so that it only happens with auth-related errors.

Version 1.28.0 (2019.06.26)

  • Added: New targetContainer configuration, which allows to append the chatbot SDK into a specific html element.
  • Fixed: Removed the "!important" elements from the Chatbot SDK CSS to make it easier to customize the styles.
  • Fixed: A bug was found on some browsers where zooming in resulted in an incorrect position for the side-window. This is now fixed.

Version 1.27.0 (2019.05.29)

  • Added: New subscription onStartConversation
  • Fixed: When the ratingPosition was set to sideWindow, the ratings were always displayed ignoring the rate flag. This is now fixed.
  • Fixed: The nl-escalation-adapter was enabling chatbot input after selecting any systemMessage option. This is now fixed.

Version 1.26.0 (2019.05.15)

  • Added: New configuration for avatar videosWithSound that enables sound on avatar videos.
  • Added: Tracking revisitable_action_field when user chooses a new option on an actionField.
  • Added: New tracking of sdk_selected_version and sdk_used_version in User information. For more information, see SDK Setup
  • SetChatbotIcon action now accepts base64 images format.
  • Added: New responsive animation when the sideWindow fades in and out.

Version 1.25.0 (2019.05.07)

  • Updated Hyperchat Adapter.

Version 1.24.1 (2019.04.17)

  • Updated Hyperchat Adapter.

Version 1.24.0 (2019.04.03)

  • Added: Source configuration.
  • Added: A new label to customize the related content title. If no label is set in the configuration, the Chabot shows the default title provided by the API.
  • Added: SessionId parameter in the getSessionData action

Version 1.23.0 (2019.03.20)

  • Added: The new helpers feature makes it easier to customize the Chatbot user interface. It detects the Chatbot DOM elements, sets bindings to those elements, and allows developers to add the Chatbot SDK actions to these custom features.
  • Added: Estonian was added to the list of supported languages.

Version 1.22.0 (2019.03.06)

  • Added: New DisplayChatbotMessage type of answer: customAnswer.
  • Fixed: The Chatbot did not respond when messageList was set to an incorrect type, as there was no failsafe behavior defined. This caused confusion for clients as it looked like the bot was correctly set but not working. This is now fixed and an error message now appears if the settings are not correct.
  • Fixed: A bug that was causing android keyboards to be displayed after every chatbotMessage.
  • Fixed: A bug was found when, after closing the bot, the subscription to "onHideConversationWindow" was not triggered. This is now fixed.

Version 1.21.1 (2019.02.21)

  • Fixed: A bug that was causing a crash on IE11.

Version 1.21.0 (2019.02.20)

Important: This version of the SDK is not compatible with IE11. Fixed in 1.21.1

  • Fixed: A bug was found where, after disabling the input with the disableInput action, and clicking on the closeButton, input was enabled upon returning to the chat window. This is now fixed and input remains disabled after closing the chat window.
  • Fixed: A bug was found where, after disabling the input using the disableInput action and refreshing the page, input was enabled upon returning to the chat window. This is now fixed and input remains disabled after refreshing the page.
  • Added: there is a new parameter in the nl-escalation-adapter called hideEscalateIntentMessage. When it is set to false, it shows the answer text or message of the escalation intent before the escalation system message. This means that if the content that triggers escalation has an answer text, you can now configure the answer text to be shown before the bot asks if the user wishes to chat with a live agent. By default this parameter is true to maintain backwards compatibility.
  • Added: New Custom HTML sections conversation-window-footer and side-window-header. It is now possible to customize the header and footer sections of the side window inside the conversation window.
  • Added: There is a new configuration parameter to select the ratingsPosition. It is possible to show the ratings in the side window only, in the conversation window only, or either (depending on whether the Chatbot answer has a conversation window or not).

Version 1.20.2 (2019.02.07)

  • Fixed: Show message when the user will not be able to connect due to some missing required browser configurations.

Version 1.20.1 (2019.02.06)

  • Fixed: DisplayChatbotMessage action in the NoAgentsAvailable configuration parameter of the internal nl-escalation-adapter was not being correctly displayed.
  • Fixed: DisplayType dropdown from displayChatbotMessage action without the fieldType parameter were no longer working after 1.19.0 SDK release. Default value now is list.

Version 1.20.0 (2019.01.23)

  • Added: New configuration delayOnMultipleAnswers to add delay on multiple message answers. By default this configuration is set to false.
  • Added: New configuration relatedContentsExpand to automatically display the related contents modules expanded. By default this configuration is set to false.
  • Fixed: Internal NL Escalation adapter input blocked if noAgentsAvailable.
  • Fixed: When refreshing the page with an opened side window, the position of the window was not correctly displayed. When refreshing the page, the side window is now rendered next to the conversation window.

Version 1.19.1 (2019.01.09)

  • Fixed: In the HyperChat Adapter when the agent had a nickname set on the CM App, it was not correctly displayed in the integration. It should now be displayed under all circumstances.

Version 1.19.0 (2018.12.19)

  • Added: New type of chatbot message which displays a calendar DisplayChatbotMessage
  • Added: New configuration showLoader, which will display a loader until the initial API requests are fulfilled. Useful for Chatbots which tend to take a while to load. By default this configuration is set to false.
  • Fixed: When sending two comments on ratings in the sideWindow, the second comment input box was retaining the text from the first comment.

Version 1.18.0 (2018.12.12)

  • Added: New subscription onDisplayRating
  • Added: New configuration autoDisplaySideWindow
  • Added: New customClass configuration on ratingOptions
  • Fixed: Chatbot with avatar configuration in responsive will now be minimised immediately.
  • buildWithDomainCredentials will now skip the getApis request, getting the information from the Auth request and will avoid performing refreshToken requests.

Version 1.17.0 (2018.11.21)

  • Added: New subscription onShowSideWindow
  • Added: New subscription onCloseSideWindow
  • Added: variables/options method in the API Client.
  • Added: Variable name on the systemMessage after changing the value of a variable using fieldOptions chatbot message.
  • Fixed: Multiple clicks on launcher caused several auth request. This is no longer the case.
  • Fixed: Down scroll caused by toggling related contents now only happens when it is on the last message.

Version 1.16.0 (2018.11.07)

  • New: Configuration tracking userInfo, which is used to track the user info in the conversation/ endpoint see doc
  • GetApis response is now cached for 24 hours
  • Added: New action rateContent which will perform the tracking of a content.
  • Added: New subscription onRateContent.
  • Added: New contact tracking methods on the natural language escalation adapter.

Version 1.15.0 (2018.10.17)

Version 1.14.3 (2018.10.03)

  • Fixed: Escalation systemMessage stopped working after page refresh.
  • Fixed: Missing labels in several languages.
  • Added: custom parameter in SystemMessage action.

Version 1.14.2 (2018.09.19)

  • Fixed: An error on Hyperchat internal adapter.

Version 1.14.1 (2018.09.19)

  • Updated Hyperchat internal adapter.

Version 1.14.0 (2018.09.19)

  • Added: The Chatbot SDK now generates messages from the messageList API attribute instead of the message attribute. This allows the bot to display multiple messages when the answerAttribute has multiple objects.
  • Added: New response configuration in the ratingOptions configuration. This shows after the user clicks on a rating.
  • Fixed: The SendMessage action now accepts a messageData with only directCall parameter.

Version 1.13.2 (2018.09.05)

  • Fixed: An issue was found where the sideWindow kept showing the rating footer even when ratings were not activated. This is now fixed.
  • Fixed: An issue was found where the bot did not automatically scroll down when the “+more info” button appeared. This is now fixed.

Version 1.13.0 (2018.08.08)

  • Added: sessionUser method in the API Client.
  • Added: getVariables method in the API Client.
  • Added: relatedContents component is not disabled if there is a directCall attribute.
  • Added: Character counter
  • Fixed: Hyperchat-only SDKs not saving state after refresh.
  • Fixed: SuggestAnswer text should be selected so the user can easily remove it.
  • Fixed: user message label in IE11.
  • Fixed: Reopening chat window doesn't take user to the bottom of the chat.
  • Fixed: Sanitize of the userMessage to avoid security issues
  • Fixed: Avatar default position corrected size
  • Fixed: displayChatbotMessage subscription now correctly modifies sideWindow parameters

Version 1.12.0 (2018.07.25)

  • Added: New avatar position configuration, on top, intended for the smaller avatar videos.
  • Added: DirectCalls, new parameter in the sendMessage, which asks the API for a content using a dynamic setting. More info
  • Added: 3 new languages configuration, Slovak, Tagalog and Vietnamese.
  • Fixed: Avatar now plays the exit video before closing the conversationWindow
  • Fixed: Ratings with comment will perform the rating up on click, and update after the comment submit.
  • Fixed: Design problem with userMessages and IE11.

Version 1.11.1 (2018.07.11)

  • Fixed: Not showing ratings on the sideWindow in some cases.

Version 1.11.0 (2018.07.11)

  • Added: Obfuscate input when the Chatbot SDK receives the 'obfuscate' flag.
  • Added: Remove ratings when the Chatbot SDK receives the 'no-ratings' flag.
  • Added: New action suggestAnswer, which will display in the input the given message. More info
  • Added: SuggestAnswer attribute in displayChatbotMessage action will trigger the suggestAnswer action.
  • Added: Both conversational-escalation, html-escalation-adapter and hyperchat adapters are now included in the SDK. More info
  • Fixed: Incompatibility issues with the require.js library
  • Fixed: Website scroll issue is broken after closing the bot in responsive view
  • Fixed: System message modal not filtering HTML.

Version 1.10.1 (2018.06.15)

  • Fixed: Internet Explorer 11 compatibility issue.

Version 1.10.0 (2018.06.13)

Important: Compatibility issue with Internet Explorer 11, fixed in 1.10.1

  • Added: New obfuscate attribute in displayChatbotMessage action. When set to true, it will obfuscate the following user input.
  • Added: New functionality on the onReady subscription. If returned a promise, the view of the Chatbot SDK will not be rendered until the promise is fulfilled. More info
  • Added: New action updateConfiguration, which will allow the update of some configurations after initiating the SDK. More info
  • Fixed: Warning when not setting an optional parameter in appData API Client method
  • Fixed: Conflict when using the API Client before performing the buildWithDomainCredentials() method
  • Fixed: close-conversation label not being translated

Version 1.9.0 (2018.05.16)

  • Added: New build method buildWithDomainCredentials, which delays the authorization until the user interacts with the chatbot. More info
  • Fixed: Improved caché in order to avoid repeated API request.
  • Fixed: Compatibility with IE11 with Japanese characters.

Version 1.8.2 (2018.05.02)

  • Fixed: extendedContentsAnswer type of answers is now allowed when neither url or side-bubble text is specified. Automatic click will be logged upon displaying content(s)
  • Fixed: Design problems with showDateTime and ratings/related
  • Fixed: Design problems with long texts in IE11
  • Fixed: Problems related to corners rounded in multiple answers title in IE11
  • Fixed: nl-escalation-adapter to display intentMatch when no agents
  • Fixed: html-escalation-form adapter to show the form inside the conversationWindow
  • Added documentation for the ShowSurvey adapter, which will display a given survey after closing the chatbot. More info

Version 1.8.1 (2018.04.18)

Version 1.8.0 (2018.04.04)

  • Added the following API Client methods:
    • Tracking events.
    • GetSurvey.
  • Added: New type of answer: extendedContentsAnswer in displayChatbotMessage action.
  • Fixed: Not setting correctly the session configuration after reconnecting.

Version 1.7.2 (2018.03.23)

  • Fixed: An error when the SDK is used in WebView app.

Version 1.7.1 (2018.03.21)

Version 1.7.0 (2018.03.7)

Version 1.6.2 (2018.02.21)

  • Fixed: Rating button icons.
  • Added: updated design in the Escalation HTML form

Version 1.6.1 (2018.02.07)

  • Fixed: IE11 compatibility.

Version 1.6.0 (2018.02.07)

  • Fixed: Avatar name configuration.
  • Fixed: Minor design upgrades.
  • Fixed: Chat messages lost after page refresh.
  • Fixed: showDate format.
  • Fixed: Disable Upload attachment when disabled input.
  • Fixed: avatar videos on safari.
  • Fixed: Avoid displaying empty answers.
  • Fixed: SideWindow Dom elements being destroyed on refresh.
  • Last last1by1Unfolded option is now configurable.
  • AppData added in the API Client.
  • API Client is now accessible in the adapters.
  • Images can now be used in the avatar.
  • Ratings can be shown on the conversationWindow.
  • Added several new languages.
  • Initial position of conversationWindow is now configurable.

Version 1.5.3 (2018-02-24)

  • Fixed authorization through bearer on refreshToken.
  • Previous versions deprecated due to infrastructure updates

Version 1.5.2 (2018.02.24)

  • Fixed avatar videos on safari 11.

Version 1.5.1 (2018.02.10)

  • Added input limit of 256 characters.
  • Fixed avatar videos on IE11.
  • Fixed babel, polyfill and lodash conflicts.

Version 1.5.0 (2017.12.27)

Version 1.4.3 (2017.12.13)

  • Fixed sideWindow automatic showing on responsive version

Version 1.4.2 (2017.12.13)

  • Minor fix related to design.
  • Fixed Internet Explorer compatibility.

Version 1.4.1 (2017.11.29)

  • Minor fix on addvariable method.

Version 1.4.0 (2017.11.29)

Version 1.3.0 (2017.11.16)

  • Korean and Japanese languages available.
  • Added related contents to the answer.

Version 1.2.0 (2017.11.16)

  • API direct-message translated after setting specific language on build configuration.

Version 1.1.0 (2017.11.10)

  • Added labels in several languages.
  • New createFromDomainKey authorization method.
  • Fixed character encoding problem.

Version 1.0.0 (2017.11.10)

  • Initial release