Webchatclient API

Es posible embeber el webchatclient de uContact mediante la adición de los siguientes scripts en su sitio o aplicación web. Para embeber el Webchat en un sitio web creado con WordPress consultar el siguiente enlace: https://integra-scm.atlassian.net/wiki/spaces/UVE/pages/407693721

<script src="https://example.ucontactcloud.com/webchatclient/integrawebchat.js"></script>
<script>
initwebchat({
    ip: "example.ucontactcloud.com",
    campaign: "nombreCampaña",
    buttonMessage: "Chatea con Nosotros!"
});
</script >

example.ucontactcloud.com hace referencia a la dirección de la instancia de uContact, se deberá sustituir con la dirección en donde se encuentra la campaña.

buttonMessage mensaje flotante que se desplegará arriba del botón de abrir el chat, puede colocarse un texto o HTML. Si no se envía el parámetro, no se mostrará.

Los scripts y la conexión del webchatclient van a apuntar directamente al servidor de uContact. En caso de que la instancia de uContact se encuentre en sitio y no en la nube hay que asegurarse de:

Habilitar el puerto 443 para la conexión HTTPS hacia uContact.
Habilitar el puerto 8089 TCP (señalización SIP por websocket) hacia el servidor de telefonía para poder realizar llamadas.
La página o aplicación web deben usar HTTPS para poder realizar llamadas. Esto es debido a las restricciones de los navegadores cuando no se usa encriptación.

Uso de los métodos

La ejecución del método initwebchat devuelve una instancia de un objeto a cuál es posible ejecutarle algunos métodos.

<script src="https://example.ucontactcloud.com/webchatclient/integrawebchat.js"></script>
<script>
let chat = initwebchat({
    ip: "example.ucontactcloud.com",
    campaign: "nombreCampaña",
    buttonMessage: "Chatea con Nosotros!"
});

chat.startInteraction('John', 'johndoe@company.com', 'Hi there!!', '+59898765432');
</script >

Método	Parámetros	Descripción

Método	Parámetros	Descripción
`toggleChat`		Permite ocultar o mostrar el chat según sea el estado
`badgeMessage`	message	Muestra al usuario final un mensaje. Al clickear en el botón del webchat el mensaje desaparece.
`startInteraction`	name, email, message, number	Con los datos proporcionados inicia una nueva interacción. Hay que tener en cuenta que este método no tiene en cuenta si se había iniciado alguna previamente.
`updateCurrentURL`		Al ejecutar este método el webchatclient envía a uContact la URL y el título de la página en ese momento para que el agente la pueda visualizar. El mismo comportamiento se tiene por defecto cuando se recarga una página. Este método es útil para aplicaciones o páginas SPA (single page application).