SDK
Il est possible d'interagir avec notre widget de webchat via l'intermédiaire d'un SDK en Javascript
Les possibilitésIl existe 2 types d'interactions possibles : des méthodes et des événements.
Les méthodes permettent d'agir directement sur la fenêtre du webchat, pour forcer son ouverture ou sa fermeture par exemple.
Les événements permettent de recevoir une information lorsqu'un utilisateur interagit avec la fenêtre du webchat, par exemple lorsqu'il ouvre ou ferme la fenêtre, ou selon certains états de cette fenêtre, par exemple lorsqu'elle est initialisée.
Fonctionnement général
<script async> function startBotSDKEventsListeners () {
// mes appels au SDK
// par exemple, si je veux forcer l'ouverture de la fenêtre : window.botSDK.open() } window.addEventListener('sdk-loaded', startBotSDKEventsListeners); </script>
Liste et fonctionnement des méthodes
Il existe plusieurs méthodes :
open();open(); permet de forcer l'ouverture de la fenêtre du webchat
window.botSDK.open()
close();
close(); permet de forcer la fermeture de la fenêtre du webchat
window.botSDK.close()
start();
start(); permet de forcer le démarrage de la conversation
window.botSDK.start()
cette méthode peut également être utilisée avec un paramètre, qui simulera l'envoi d'un message provenant de l'utilisateur.
window.botSDK.start('Comment je peux changer mon mot de passe ?')
restart();
restart(); permet de forcer la relance de la conversation et simule une mise à zéro.
window.botSDK.restart()
destroy();
destroy(); est utilisé pour totalement supprimer le webchat de votre page.
window.botSDK.destroy()
setTcfParams();
setTcfParams(); est utilisé pour mettre à jour des paramètres envoyés depuis votre page HTML (via le script) vers le bot, pour par exemple de l'identification utilisateur ou du passage de contexte.
Il est nécessaire de redémarrer le bot en amont
window.botSDK.restart();
window.botSDK.setTcfParams({
data: {
user: {
lastname: 'Doe',
firstname: 'John'
}
}
})
cleanStorage();
cleanStorage(); permet de supprimer les informations du webchat sur le navigateur de l'utilisateur. Il peut être utilisé pour une remise à zéro ou pour mettre en place des fonctionnalités liées à la confidentialité des données.
window.botSDK.cleanStorage()
Liste et fonctionnement des événements
Les événements sont multiples :
onInitStart()window.botSDK.onInitStart(function (e) { /* do something */ });
window.botSDK.onInitEnd(function (e) { /* do something */ });
window.botSDK.onOpenBot(function (e) { /* do something */ });
window.botSDK.onCloseBot(function (e) { /* do something */ });
window.botSDK.onClosePreonboarding(function (e) { /* do something */ });
window.botSDK.onDiscussionStart(function (e) { /* do something */ });
window.botSDK.onReceiveMessage(function (e) { /* do something */ });
window.botSDK.onSDKLoaded(function (e) { /* do something */ });