ChatCaptain JavaScript API

Onboarding Text bearbeiten und anzeigen/verstecken

Du kannst den Onboarding Text einmal über die ChatCaptain App bearbeiten und für alle Seiten festelegen. Also eine standard Einstellung festlegen. Du kannst aber auch über die JavaScript API den Text dynamisch anpassen und diesen anzeigen oder verstecken.

//Auf die ChatCaptain API zugreifen
var onboarding = chatCaptain.api.onboarding;
//Onboarding Text ändern
onboarding.set('Hi, kann ich dir behilflich sein?');
//Onboarding Text anzeigen
onboarding.show();
//Onboarding Text verstecken
onboarding.hide();

Chat öffnen/schließen

In manchen Situationen ist es vielleicht erforderlich, dass der Chat nicht durch den Klick auf den Button von ChatCaptain geöffnet wird. Beispielsweise, wenn du einen eigenen Button verwendest oder aus einem anderen Grund den Chat öffnen oder schließen möchtest.

//Auf die ChatCaptain API zugreifen
var chat = chatCaptain.api.chat;
//Chat öffnen
chat.open();
//Chat schließen
chat.close();

Chat Einstieg festlegen

Standardmäßig wird der Einstieg durch die Konfiguration im Chatbot Builder festegelegt. Der Block, der mit dem Einstiegsmodul verbunden ist, wird als erstes und somit als Einstieg für den Nutzer angezeigt. Du kannst aber auch den Einstieg in abhängigkeit der jeweiligen Seite anpassen. Beispielsweise kannst du einen anderen Einstieg anzeigen, wenn der Nutzer bereits im Kaufprozess befindet.

//Auf die ChatCaptain API zugreifen und Einstieg festlegen
chatCaptain.api.chat.setEntry('flow/block');
//TODO script Integration

Du findest die BlockId für die setEntry Methode im Chatbot Builder. Klicke einen Block an und klicke dann oben rechts auf "Sidebar öffnen". Die BlockId wird dir nun angezeigt.

Falls du noch keinen Block erstellt hast, der als Einstieg dienen soll, füge einen neuen hinzu. Du musst diesen dann nicht mit dem Einstiegsmodul verbinden.

Nachricht senden

Du kannst Nachrichten über die JavaScript API an deine Nutzer senden.

caution

Die gesendeten Nachrichten werden aktuell nicht im Chat Protokoll gespeichert

//Auf die ChatCaptain API zugreifen und Nachricht senden
chatCaptain.api.sendMessage('Hallo Welt!');

Block ausführen

Abgehesen von einer eigenen Nachricht über die sendMessage Method, kannst du ChatCaptain anweise, einen bestimmten Block auszuführen. Der Nutzer erhält dann entsprechend kurze Zeit später die Nachricht(en) des Chatbots.

//Auf die ChatCaptain API zugreifen und Block ausführen
chatCaptain.api.performBlock('flow/block');

Du findest die BlockId für die performBlock Methode im Chatbot Builder. Klicke einen Block an und klicke dann oben rechts auf "Sidebar öffnen". Die BlockId wird dir nun angezeigt.

Einstieg dynamisch festlegen

Man könnte annehmen, diese Method sei überflüssig, da es bereits eine Method zum festlegen des Einstiegspunktes gibt. Aber anders als die setEntry Methode, führt diese Methode den angegebenen Block aus, falls der Nutzer bereits zuvor mit dem Chatbot kontakt hatte. Die setEntry Methode würde in diesem Fall keine Funktion haben.

//Auf die ChatCaptain API zugreifen und Block ausführen
chatCaptain.api.enter('flow/block');

Du findest die BlockId für die enter Methode im Chatbot Builder. Klicke einen Block an und klicke dann oben rechts auf "Sidebar öffnen". Die BlockId wird dir nun angezeigt.