API Changelog
The following table lists significant updates and modifications to the Whisbi API. If a variable is modified, the old values will still be valid unless stated.
| Version | Description |
|---|---|
v1.33.0 December 01, 2019 | Added new checkScoreBeforeWidgetLoaded event on the General Events section which allows to receive the score values from different providers and also determine whether or not start or stop the Widget. Added new command setNowInteractScore similar to openWidget allowing Now Interact to send a score to the Widget. |
v1.32.0 November 30, 2019 | Added new enableAbr parameter to the Api config which allows the video player to dynamically adjust video quality based on a user’s available bandwidth, device performance, and network conditions. |
v1.31.0 October 9, 2019 | Added oneToMany.firstHLC in order to show the HLC on top of the broadcast. |
v1.30.0 July 11, 2019 | Added new chatbotBeforeExternalMessageSimple event on the Chatbot Events section which allows receiving a variables object from an external source to be interpolated inside the text of the chatbot dynamic simple text node. Added documentation for version 3.8 of the chatbot which includes the dynamic simple text node |
v1.29.0 June 03, 2019 | Added new googleAnalyticsClientId parameter to allow sending Google Analytics events to a specific account. |
v1.28.0 May 30, 2019 | Added new chatbotId parameter to the API config section which allows loading a chatbot. Added new chatbotName parameter to the API config section which allows naming a chatbot. |
v1.27.0 March 08, 2019 | Added new chatbotBeforeExternalCatalog event on the Chatbot Events section which allows receiving an array of options from an external source to be displayed on the chatbot catalog node. Added documentation for version 3.7 of the chatbot which includes external catalog options |
Chatbot config v3.6 March 15, 2019 | Added documentation for the 3.6 chatbot version including the new node type message_catalog which allows asking the customers to choose within a set of visual options, which have an image and a short text. |
v1.26.1 March 6, 2019 | Added otoNoAgentsAvailable, otoInvalidPhone, and otoCallError events to the Sell session events section which allows the tracking of invalid phones, call errors, and unavailable agents. |
Chatbot config v3.5 February 25, 2019 | Added documentation for the 3.5 chatbot version including the new attribute validation to add a validation pattern and a custom error on input name, input phone, and input text fields. |
v1.26.0 February 14, 2019 | Added floatingButton, onMobile, and maxUserPictures parameters on the Sell Styles section which allows limiting the number of agent images to display within the floating button on mobile. |
v1.25.0 February 12, 2019 | Added onDesktop, onMobile, connectForm and inbound parameters on the Sell Config section which allows enabling functionalities by the device. The current inbound property will be deprecated from oneToOne.inbound |
v1.24.0 January 15, 2019 | Added new chatbotBeforeExternalSelect event on the Chatbot Events section which allows receiving an array of options from an external source to be displayed on the select field. Added documentation for version 3.4 of the chatbot which includes external options in a select input |
v1.23.2 January 15, 2019 | Added otmChatbotDeclined event to the Engage session events section which allows to track the negative response in the Engage chatbot. |
v1.23.1 January 14, 2019 | Updated the otmSessionStarted event which now returns the sessionId and cookieGuid. Its description can be found in the Engage session events section. |
v1.23.0 January 8, 2019 | Added new languageVariation parameter to the General config section which allows loading a language variation. |
v1.22.0 December 21, 2018 | Added new enableWhisbiLink parameter to the General config section which allows enable or disable the link placed at the bottom of the widget. |
v1.21.0 December 20, 2018 | Added otoPreSessionRequest on the events section which allows to modify or add data before a request is made. |
v1.20.0 December 19, 2018 | Added maxLength and maxWords properties on oneToMany.activeViewerForm.name in order to define the maximum number of characters and words allowed on the name field that’s asked on the beginning of an Engage live broadcast. |
v1.19.1 November 30, 2018 | Added new chatbotEnd event on the Events section which allows knowing when a lead has been closed within the chatbot. |
v1.19.0 November 22, 2018 | Added onDesktop, onMobile, marginX and marginY parameters on the General Config floating button styles section which allows to setting the position of the Floating Button |
v1.18.0 November 12, 2018 | Added new textColor parameter to the General Config header styles section. Added a new oneToOneDisplay parameter to the Engage Config section. Added new videoOverlay style to the Engage Styles Config section. |
Chatbot config v3.3 October 31, 2018 | Added documentation for version 3.3 of the chatbot it includes a new action type end and a new parameter resultCode for node message_simple and message_link. |
Chatbot config v3.2 October 8, 2018 | Added documentation for version 3.2 of the chatbot , which includes the new field types input_text and select on the node type message_session_data. |
v1.17.0 September 10, 2018 | Added new outOfHoursConfigURL option to the Sell Chatbot Config section. Added the documentation of the chatbot version 3.1 , which includes a new node type message_inbound, and changes in the structure of the node type message_session_data. |
Chatbot config v3.0 August 23, 2018 | Added a new link for Chatbot v3.0 documentation inside the Sell config section. |
v1.16.0 August 22, 2018 | Added new defaultUserPictures option to the Sell Config section. |
v1.15.0 July 19, 2018 | Added new link to chatbot version 2.1 inside Chatbot config section. Renamed API parameter hasGDPR to legalReference in the API config section. Removed property GDPRType from the General config section. Legal agreements will always be presented on a new screen. Added new event otoPinCodeGenerated to the events section. Renamed event transferScreenShowed to otoCallTransferred in the events section. Recovered parameter playerText inside API config to allow customers to change “Join live broadcast” text inside the mobile version of Engage. |
v1.14.0 July 10, 2018 | Added new backgroundImage option to the Sell styles section. |
v1.13.0 June 21, 2018 | Added api.simplyBook to get available dates from Simply Book. Added general.styles.floatingButton.collapseType to determine where the customer has to click to collapse the conversation bubble. |
v1.12.0 June 21, 2018 | Added new property direction inside styles config which allows set experience in RTL (right to left) or LTR (left to right). Added the option to add an extra field to Sell forms, both the main form and the call scheduling form. Added new property firstDayOfWeek to oneToOne.schedule in order to set the first day of the week in the calendar. Added new method to launch Whisbi widget from your own website. Added new variable customInboundAction to the oneToOne section of the config. Added new events otoInboundClicked and otoInboundToWhisbiLoaded to the events section. |
v1.11.0 May 25, 2018 | Added oneToMany.visibilityType in order to disable the option to rate the agent. Added new entry for GDPR inside API Config and General Config section. Added customizable cookies expiration time to the API Config section. Added option to disable Google Analytics tracking to the General Config section. |
v1.10.0 May 15, 2018 | Added oneToMany.visibilityType in order to hide the Engage floating button. |
v1.9.0 May 1, 2018 | Added new event transferScreenShowed to the events section. |
v1.8.0 January 20, 2018 | Added oneToOne.form.conversationalMode in order to ask for data in a conversational mode. oneToOne.schedule.emailTo in order to set an email to send scheduled leads info. Added new event widgetLoaded to the events section. |
v1.7.0 January 24, 2018 | Added oneToMany.disableLike in order to disable the option to rate the agent. oneToOne.ratingType has been modified to accept both the previous values and the new ones: nps-dots, nps-emoji, service-rating, none. Added the event events.otmNameEntered that fires when the user enters his name on an Engage session. |