WoztellWebchat.js

Puedes usar WoztellWebchat.js para crear distintas interacciones entre tu sitio web y el chat web.

init

Inicializa el plugin de chat web con los parámetros indicados.

WoztellWebchat.init({version: "1.0", token: "TOKEN"}, {options})

Parámetros

Nombre	Tipo	Descripción
version	string	Versión de la integración de Web Chat
token	string	Token único para cada integración de Web Chat
options	object	opcional

Opciones

Nombre	Tipo	Descripción
Default Open	boolean	Controla si el marco del messenger se abre cuando el chat web se inicializa correctamente. Por defecto es false.
ref	string	Para pasar datos personalizados cuando el usuario inicia una conversación con el chatbot por primera vez.
Greetings	string	Texto personalizado que se muestra junto al icono antes de que el usuario haga clic.
Default Locale	string	Define el idioma inicial del usuario. Debe ser uno de los nombres de grupo de locale creados en la integración de Web Chat.
Not Ready Icon URL	string	URL de imagen para personalizar el icono cuando hay un problema de conexión con el servidor de Web Chat.
Not Ready Text	string	Texto personalizado cuando hay un problema de conexión con el servidor de chat web.
Load Delay	integer	Por defecto: 3000 ms. Tiempo de espera hasta que aparece el icono de no disponible. Durante la espera, el sistema comprueba cada 300 ms si el Web Chat está listo.
Welcome Message	string	Mensaje que se muestra al abrir el chat web (por ejemplo, un saludo antes de que el usuario envíe el primer mensaje).

Ejemplo

const loadWoztell = async () => {
  WoztellWebchat.init(
    {
      version: "1.0",
      token: "",
    },
    {
      defaultOpen: true,
      notReadyText: "Loading...",
      loadDelay: 1000,
      welcomeMessage:
        "Bienvenido. ¿Cómo puedo ayudarte?",
    }
  );
};

subscribe

Usa subscribe para escuchar ciertos eventos del chat web.

WoztellWebchat.subscribe(EVENT_NAME, callback)

Parámetros

Nombre	Tipo	Descripción
EVENT_NAME	string	Puede ser: WEB_ACTION, READY, OPEN_WEBCHAT, CLOSE_WEBCHAT
callback	function	Función de callback que recibe el objeto del evento como parámetro

WEB_ACTION

El evento WEB_ACTION se envía cuando el chatbot emite una respuesta WEB_ACTION.

Propiedades de event:

Nombre	Tipo	Descripción
event	string	WEB_ACTION
data	object	Todas las propiedades personalizadas definidas en tu respuesta de WOZTELL
from	string	ID del bot. En web chat, suele ser el ID del canal
to	string	ID del usuario
timestamp	number	Hora de la actualización (epoch en milisegundos)

READY

Se envía cuando la inicialización del plugin de webchat ha finalizado.

Nombre	Tipo	Descripción
event	string	READY

OPEN_WEBCHAT

Se envía cuando se abre el marco del messenger.

Nombre	Tipo	Descripción
event	string	OPEN_WEBCHAT

CLOSE_WEBCHAT

Se envía cuando se cierra el marco del messenger.

Nombre	Tipo	Descripción
event	string	CLOSE_WEBCHAT

sendEvent

Cuando el usuario realiza acciones en tu sitio web, usa sendEvent para interactuar con el plugin de chat web (abrir/cerrar el chat o enviar eventos a WOZTELL para activar un flujo del chatbot).

WoztellWebchat.sendEvent(EVENT_NAME, data, options)

Parámetros

Nombre	Tipo	Descripción
EVENT_NAME	string	Puede ser: WEB_EVENT, OPEN_WEBCHAT, CLOSE_WEBCHAT
data	string / object	opcional
options	object	opcional

WEB_EVENT

WEB_EVENT envía datos personalizados a WOZTELL para activar una conversación del chatbot.

WoztellWebchat.sendEvent(
  "WEB_EVENT",
  {
    payload: "SOME_PAYLOAD",
    selectedOption: "OPTION_A",
  },
  {
    openMessenger: true,
  }
);

Nombre	Tipo	Descripción
data	string / object	Datos JSON personalizados para enviar a WOZTELL
options	object	opcional

Opciones:

Nombre	Tipo	Descripción
openMessenger	boolean	Si el marco del messenger debe abrirse al enviar el evento. Por defecto es false.

OPEN_WEBCHAT

Evento para abrir el marco del messenger.

WoztellWebchat.sendEvent("OPEN_WEBCHAT")

CLOSE_WEBCHAT

Evento para cerrar el marco del messenger.

WoztellWebchat.sendEvent("CLOSE_WEBCHAT")