Website API Guide

Website API Guide

By default, the Talkative functionality is accessed within the default Talkative UI.

The Talkative Engage API allows you create your own triggers and logic and embed them within any existing web element on your website.

Note: You must first specify the :api-features attribute in order for the API to work. Please read Adding Scripts for further information.

TalkativeEngageApi Class

The Class provides basic information about the interaction, QOS and feature initiation methods.

Class Properties

Tables can't be imported directly. Please insert an image of your table which can be found here.

TalkativeEngageApi.qos output:


Class Methods


TalkativeEngageApi.readyCallback() Customer specified callback which is called once all checks have been performed and the software is ready to begin. Returns Object which contains qos information.


TalkativeEngageApi.isActive() Returns true or false based on whether there is an active interaction.


TalkativeEngageApi.startChat() This method allows you to start a chat session.


TalkativeEngageApi.startCobrowse() This method allows you to start a cobrowsing session.


TalkativeEngageApi.startEmail() This method will open the email form.


TalkativeEngageApi.startVoice() This method allows you to start a web call session.

minimise UI

window.TalkativeEngageApi.collapseUi() This method allows you to minimise the UI during an interaction.


Below is a real life example of how the the Talkative functionality can be embedded into existing website elements:


readyCallback can be setup by declaring the function above the Talkative Engage Tag. For example:

windowfunction (results) console'We are ready to begin!'

Related: Guide: Adding Scripts