API JavaScript Live Chat

Utilisez l'API JavaScript onWebChat pour personnaliser votre widget de chat et automatiser les flux. Vous pouvez transmettre les données du visiteur, définir la langue du widget, maximiser ou masquer le widget et plus encore.

Par exemple, vous pouvez envoyer les détails du visiteur au chat, définir la langue par page ou ouvrir le widget par programmation lorsqu'un utilisateur clique sur un bouton.

Ajoutez votre code API directement sous le script du widget de chat, comme indiqué à droite.





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

Définir les informations visiteur

Vous pouvez définir les informations du visiteur avant ou pendant une session de chat. Par exemple, définir le nom aide votre équipe à identifier les contacts dans la liste des visiteurs.

Utilisez ces appels API pour définir le nom, l'email, le téléphone et les notes du visiteur :



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

Obtenir les informations visiteur

Vous pouvez également récupérer les détails du visiteur définis via l'API, le formulaire pré-chat ou mis à jour par les agents.

Appelez ces fonctions après le chargement complet du widget. Exemple :
onWebChat.set("onWebChatLoaded", function() { console.log("visitor name: " + onWebChat.get("name")); });



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

Définir la langue du widget

Définissez la langue du widget avec le code de langue pour toute langue activée dans votre tableau de bord.

Par exemple, "fr" pour le français, "en" pour l'anglais et "es" pour l'espagnol. Si le code n'est pas activé, le widget utilise votre langue par défaut. Modifiez la langue par défaut dans Paramètres > Langues.

Codes de langue disponibles :

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

Définir l'apparence du widget

Vous pouvez contrôler les principaux paramètres d'affichage du widget :

Utilisez le paramètre max avec 0 pour minimiser ou 1 pour maximiser le widget.

Pour masquer le widget, utilisez la fonction set avec le paramètre show et la valeur 0. Utilisez 1 pour l'afficher à nouveau.





    onWebChat.set("max",1);

    onWebChat.set("show",0);

Définir les informations de page

Vous pouvez remplacer l'URL et le titre de la page actuelle envoyés à onWebChat :

Utilisez le paramètre pageUrl pour définir une URL personnalisée visible par les agents dans la console de chat. Utile pour les applications monopages (SPA) ou le routage personnalisé.

Utilisez le paramètre pageTitle pour définir un titre personnalisé que les agents verront à la place du titre de la page du navigateur.





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

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

Obtenir le statut du widget

Pour récupérer le statut du widget onWebChat :

La fonction renvoie « online » ou « offline » selon la disponibilité actuelle de votre chat.

Appelez après le chargement du widget. Exemple :
onWebChat.set("onWebChatLoaded", function() { console.log("chat status: " + onWebChat.get("status")); });






    onWebChat.get("status");

Fonctions Callback

Vous pouvez exécuter des fonctions callback lors d'événements spécifiques du chat :

onClick s'exécute quand le visiteur clique sur le widget de chat

onMaximize s'exécute quand le widget est maximisé

onMinimize s'exécute quand le widget est minimisé

onTrigger s'exécute quand un déclencheur est activé

onStartWriting s'exécute quand le visiteur commence à taper

onWebChatLoaded s'exécute quand le widget de chat a fini de charger




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

Retour au Support