API JavaScript Live Chat

Usa l'API JavaScript di onWebChat per personalizzare il widget di chat e automatizzare i flussi. Puoi passare dati del visitatore, impostare la lingua del widget, massimizzare o nascondere il widget e altro.

Ad esempio, puoi inviare i dettagli del visitatore alla chat, impostare la lingua per pagina o aprire il widget a livello di programmazione quando un utente fa clic su un pulsante.

Aggiungi il tuo codice API subito sotto lo script del widget di chat, come mostrato a destra.





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

Impostare Informazioni Visitatore

Puoi impostare i dettagli del visitatore prima o durante una sessione di chat. Ad esempio, impostare il nome aiuta il team a identificare i contatti nella Lista Visitatori.

Usa queste chiamate API per impostare nome, email, telefono e note del visitatore:



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

Ottenere Informazioni Visitatore

Puoi anche recuperare i dettagli del visitatore impostati tramite l'API, il modulo pre-chat o gli aggiornamenti degli agenti.

Chiama queste funzioni dopo il caricamento completo del widget. Esempio:
onWebChat.set("onWebChatLoaded", function() { console.log("visitor name: " + onWebChat.get("name")); });



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

Impostare Lingua del Widget

Imposta la lingua del widget usando il codice lingua per qualsiasi lingua attivata nella tua dashboard.

Ad esempio, "it" per italiano, "en" per inglese e "es" per spagnolo. Se il codice non è attivato, il widget usa la lingua predefinita. Puoi aggiornare la lingua predefinita in Impostazioni > Lingue.

Codici lingua disponibili:

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

Impostare Aspetto del Widget

Puoi controllare le impostazioni di visualizzazione principali del widget:

Usa il parametro max con 0 per minimizzare o 1 per massimizzare il widget.

Per nascondere il widget, usa la funzione set con il parametro show e valore 0. Usa 1 per mostrarlo di nuovo.





    onWebChat.set("max",1);

    onWebChat.set("show",0);

Impostare Informazioni Pagina

Puoi sovrascrivere l'URL e il titolo della pagina corrente inviati a onWebChat:

Usa il parametro pageUrl per impostare un URL personalizzato visibile agli agenti nella console della chat. Utile per le single-page app (SPA) o il routing personalizzato.

Usa il parametro pageTitle per impostare un titolo personalizzato che gli agenti vedranno invece del titolo della pagina del browser.





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

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

Ottenere Stato del Widget

Per recuperare lo stato del widget onWebChat:

La funzione restituisce "online" o "offline" in base alla disponibilità chat attuale.

Chiama dopo il caricamento del widget. Esempio:
onWebChat.set("onWebChatLoaded", function() { console.log("chat status: " + onWebChat.get("status")); });






    onWebChat.get("status");

Funzioni Callback

Puoi eseguire funzioni callback quando si verificano eventi specifici del chat:

onClick si esegue quando il visitatore clicca sul widget di chat

onMaximize si esegue quando il widget è massimizzato

onMinimize si esegue quando il widget è minimizzato

onTrigger si esegue quando un trigger è attivato

onStartWriting si esegue quando il visitatore inizia a scrivere

onWebChatLoaded si esegue quando il widget di chat ha finito di caricare




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

Torna al Supporto