Live-Chat JavaScript API

Nutzen Sie die onWebChat JavaScript API, um Ihr Chat-Widget anzupassen und Chat-Workflows zu automatisieren. Sie können Besucherdaten übergeben, die Widget-Sprache setzen, das Widget maximieren oder ausblenden und mehr.

Sie können beispielsweise Besucherdetails an den Chat senden, die Sprache pro Seite festlegen oder das Widget programmgesteuert öffnen, wenn ein Nutzer auf einen Button klickt.

Fügen Sie Ihren API-Code direkt unter dem Chat-Widget-Skript ein, wie rechts gezeigt.





    <script type='text/javascript'>
        ... onWebChat widget code ...
    </script>
    <script type='text/javascript'>
        ... API functions goes here ...
    </script>

Besucherinformationen setzen

Sie können Besucherdetails vor oder während einer Chat-Sitzung setzen. Die Besuchernamen helfen Ihrem Team, Kontakte in der Besucherliste zu identifizieren.

Verwenden Sie die folgenden API-Aufrufe, um Name, E-Mail, Telefon und Notizen eines Besuchers zu setzen:



    onWebChat.set("name","John");
    onWebChat.set("email","john@mail.com");
    onWebChat.set("phone","1234567890");
    onWebChat.set("notes","notes for visitor ..");

Besucherinformationen abrufen

Sie können auch Besucherdetails abrufen, die über die API, das Pre-Chat-Formular oder durch Agenten-Updates festgelegt wurden.

Rufen Sie diese Funktionen auf, nachdem das Widget vollständig geladen ist. Beispiel:
onWebChat.set("onWebChatLoaded", function() { console.log("visitor name: " + onWebChat.get("name")); });



    onWebChat.get("name");
    onWebChat.get("email");
    onWebChat.get("phone");
    onWebChat.get("notes");

Widget-Sprache setzen

Setzen Sie die Widget-Sprache mit dem Sprachcode für jede in Ihrem Dashboard aktivierte Sprache.

Verwenden Sie z. B. "de" für Deutsch, "en" für Englisch und "fr" für Französisch. Wenn ein Sprachcode nicht aktiviert ist, wechselt das Widget zur Standardsprache. Sie können die Standardsprache unter Einstellungen > Sprachen ändern.

Verfügbare Sprachcodes:

am ar az be bg bn bs ca cs da de dv dz el en es et fa fi fil fo fr he hi hr ht hu hy id is it ja ka kk kl km ko ky la lb lo lt lv mg mk mn ms mt my ne nl no pl ps pt ro ru rw si sk sl sm so sq sr sv sw tg th ti tk to tr uk ur uz vi zh zh-TW





    onWebChat.set("language","es");

Widget-Erscheinungsbild setzen

Sie können wichtige Anzeigeeinstellungen des Widgets steuern:

Verwenden Sie den Parameter max mit 0 zum Minimieren oder 1 zum Maximieren des Widgets.

Um das Widget auszublenden, verwenden Sie die Funktion set mit dem Parameter show und dem Wert 0. Verwenden Sie 1, um es wieder anzuzeigen.





    onWebChat.set("max",1);

    onWebChat.set("show",0);

Seiteninformationen setzen

Sie können die aktuelle Seiten-URL und den Titel überschreiben, die an onWebChat gesendet werden:

Verwenden Sie den Parameter pageUrl, um eine benutzerdefinierte URL festzulegen, die den Agenten in der Chat-Konsole angezeigt wird. Dies ist nützlich für Single-Page-Apps (SPA) oder benutzerdefiniertes Routing.

Verwenden Sie den Parameter pageTitle, um einen eigenen Titel festzulegen, den Agents anstelle des Browser-Seitentitels sehen.





    onWebChat.set("pageUrl","https://onwebchat.com/newPage");

    onWebChat.set("pageTitle","New title");

Widget-Status abrufen

Um den onWebChat Widget-Status abzurufen:

Die Funktion gibt „online“ oder „offline“ basierend auf Ihrer aktuellen Chat-Verfügbarkeit zurück.

Rufen Sie dies nach dem Laden des Widgets auf. Beispiel:
onWebChat.set("onWebChatLoaded", function() { console.log("chat status: " + onWebChat.get("status")); });






    onWebChat.get("status");

Callback-Funktionen

Sie können Callback-Funktionen ausführen, wenn bestimmte Chat-Ereignisse eintreten:

onClick wird ausgeführt, wenn ein Besucher auf das Chat-Widget klickt

onMaximize wird ausgeführt, wenn das Widget maximiert wird

onMinimize wird ausgeführt, wenn das Widget minimiert wird

onTrigger wird ausgeführt, wenn ein Trigger aktiviert wird

onStartWriting wird ausgeführt, wenn ein Besucher zu tippen beginnt

onWebChatLoaded wird ausgeführt, wenn das Chat-Widget fertig geladen ist




    onWebChat.set("onClick",function(){ alert('chat widget is clicked'); });

    onWebChat.set("onMaximize",function(){ alert('chat maximized'); });

    onWebChat.set("onMinimize",function(){ alert('chat maximized'); });

    onWebChat.set("onTrigger",function(){ alert('trigger activated'); });

    onWebChat.set("onStartWriting",function(){ alert('visitor is writing'); });

    onWebChat.set("onWebChatLoaded",function(){ alert('chat widget is loaded'); });

Zurück zum Support