API JavaScript Live Chat

Użyj API JavaScript onWebChat, aby dostosować widget chatu i automatyzować przepływy. Możesz przekazywać dane gościa, ustawiać język widgetu, maksymalizować lub ukrywać widget i inne.

Na przykład możesz wysłać szczegóły gościa do chatu, ustawić język dla konkretnej strony lub otworzyć widget programowo, gdy użytkownik kliknie przycisk.

Dodaj swój kod API tuż pod skryptem widgetu chatu, jak pokazano po prawej.





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

Ustawianie danych gościa

Możesz ustawiać dane gościa przed lub podczas sesji chatu. Ustawienie imienia pomaga zespołowi identyfikować kontakty na liście gości.

Użyj tych wywołań API, aby ustawić imię, e-mail, telefon i notatki gościa:



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

Pobieranie danych gościa

Możesz również pobrać szczegóły gościa ustawione przez API, formularz pre-chat lub zaktualizowane przez agentów.

Wywołaj te funkcje po pełnym załadowaniu widgetu. Przykład:
onWebChat.set("onWebChatLoaded", function() { console.log("visitor name: " + onWebChat.get("name")); });



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

Ustawianie języka widgetu

Ustaw język widgetu używając kodu języka dla dowolnego języka włączonego w panelu.

Np. "pl" dla polskiego, "en" dla angielskiego i "de" dla niemieckiego. Jeśli kod nie jest włączony, widget używa domyślnego języka. Zmień domyślny w Ustawienia > Języki.

Dostępne kody języków:

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");

Ustawianie wyglądu widgetu

Możesz kontrolować główne ustawienia wyświetlania widgetu:

Użyj parametru max z 0 do minimalizacji lub 1 do maksymalizacji widgetu.

Aby ukryć widget, użyj funkcji set z parametrem show i wartością 0. Użyj 1, aby ponownie pokazać.





    onWebChat.set("max",1);

    onWebChat.set("show",0);

Ustawianie informacji o stronie

Możesz nadpisać aktualny adres URL i tytuł strony wysyłane do onWebChat:

Użyj parametru pageUrl, aby ustawić niestandardowy adres URL widoczny dla agentów w konsoli chatu. Przydatne dla aplikacji typu single-page (SPA) lub niestandardowego routingu.

Użyj parametru pageTitle, aby ustawić niestandardowy tytuł, który agenci zobaczą zamiast tytułu strony przeglądarki.





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

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

Pobieranie statusu widgetu

Aby pobrać status widgetu onWebChat:

Funkcja zwraca „online” lub „offline” w zależności od aktualnej dostępności chatu.

Wywołaj po załadowaniu widgetu. Przykład:
onWebChat.set("onWebChatLoaded", function() { console.log("chat status: " + onWebChat.get("status")); });






    onWebChat.get("status");

Funkcje callback

Możesz uruchamiać funkcje callback przy określonych zdarzeniach chatu:

onClick uruchamia się, gdy gość klika w widget chatu

onMaximize uruchamia się, gdy widget jest maksymalizowany

onMinimize uruchamia się, gdy widget jest minimalizowany

onTrigger uruchamia się, gdy wyzwalacz jest aktywowany

onStartWriting uruchamia się, gdy gość zaczyna pisać

onWebChatLoaded uruchamia się, gdy widget chatu skończy ładowanie




    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'); });

Powrót do Wsparcia