API JavaScript de Live Chat

Usa la API JavaScript de onWebChat para personalizar tu widget de chat y automatizar flujos. Puedes pasar datos del visitante, definir el idioma del widget, maximizar u ocultar el widget y más.

Por ejemplo, puedes enviar los datos del visitante al chat, definir el idioma por página o abrir el widget programáticamente cuando el usuario hace clic en un botón.

Añade tu código API justo debajo del script del widget de chat, como se muestra a la derecha.





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

Definir información del visitante

Puedes definir los datos del visitante antes o durante una sesión de chat. Por ejemplo, definir el nombre ayuda a tu equipo a identificar contactos en la lista de visitantes.

Usa estas llamadas API para definir nombre, email, teléfono y notas del visitante:



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

Obtener información del visitante

También puedes recuperar los datos del visitante definidos por la API, el formulario pre-chat o las actualizaciones de los agentes.

Llama a estas funciones cuando el widget esté completamente cargado. Ejemplo:
onWebChat.set("onWebChatLoaded", function() { console.log("visitor name: " + onWebChat.get("name")); });



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

Definir idioma del widget

Define el idioma del widget con el código de idioma para cualquier idioma activado en tu panel.

Por ejemplo, "es" para español, "en" para inglés y "fr" para francés. Si el código no está activado, el widget usa tu idioma por defecto. Puedes cambiar el idioma por defecto en Ajustes > Idiomas.

Códigos de idioma 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");

Definir aspecto del widget

Puedes controlar las opciones principales de visualización del widget:

Usa el parámetro max con 0 para minimizar o 1 para maximizar el widget.

Para ocultar el widget, usa la función set con el parámetro show y valor 0. Usa 1 para mostrarlo de nuevo.





    onWebChat.set("max",1);

    onWebChat.set("show",0);

Definir información de página

Puedes sobrescribir la URL y el título de la página actual que se envían a onWebChat:

Usa el parámetro pageUrl para establecer una URL personalizada visible para los agentes en la consola de chat. Útil para aplicaciones de una sola página (SPA) o enrutamiento personalizado.

Usa el parámetro pageTitle para definir un título personalizado que verán los agentes en lugar del título de la página del navegador.





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

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

Obtener estado del widget

Para obtener el estado del widget de onWebChat:

La función devuelve "online" u "offline" según la disponibilidad actual de tu chat.

Llama a esta función cuando el widget esté cargado. Ejemplo:
onWebChat.set("onWebChatLoaded", function() { console.log("chat status: " + onWebChat.get("status")); });






    onWebChat.get("status");

Funciones callback

Puedes ejecutar funciones callback cuando ocurren eventos concretos del chat:

onClick se ejecuta cuando el visitante hace clic en el widget de chat

onMaximize se ejecuta cuando el widget se maximiza

onMinimize se ejecuta cuando el widget se minimiza

onTrigger se ejecuta cuando se activa un trigger

onStartWriting se ejecuta cuando el visitante empieza a escribir

onWebChatLoaded se ejecuta cuando el widget de chat termina de cargar




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

Volver al Soporte