Webim (API de bots externos 2.0)

Webim es una de las plataformas omnicanal más populares para comunicarse con los clientes en canales de texto. Puedes utilizarla como canal para publicar tu negocio como operador de bots. Este artículo trata sobre la conexión de bots a través de una API asíncrona - Webim External Bot API 2.0

Webim puede utilizarse como servicio de suscripción en la nube o alojarse en los servidores privados del cliente como solución en caja. La dirección de la cuenta Webim se utiliza para establecer una conexión y como operador de bot - ver Conexión.

• Cuando se utiliza Webim como servicio de suscripción en la nube, la dirección de la cuenta Webim tiene el aspecto de <nombre_de_alguien>.webim.ru, donde <nombre_de_alguien> es el nombre del subdominio establecido en la configuración de la cuenta Webim.

• Cuando se aloja Webim en los servidores privados del cliente, la dirección de la cuenta la establece el cliente y depende del dominio de alojamiento.

Conexión

Configuración del bot en el lado Webim

En primer lugar, debe configurarlo en el lado Webim.

1. Inicie sesión en Webim como administrador.

2. Ve a Configuración → Bots.

3. Empieza a crear un nuevo bot y rellena los siguientes campos:

   1. Operador para el bot - seleccione el operador al que se vinculará el bot; se recomienda crear operadores distintos para los bots.

   2. Tipo de bot: selecciona Bot inteligente.

   3. Orden de clasificación - el orden determina en qué lugar de la lista de bots se situará este bot. Cuanto menor sea el número, mayor será la prioridad.

   4. Estado - seleccione el estado del bot.

   5. Versión - seleccione la versión 1.

   6. Enlace a API externa - introduzca la dirección del webhook, se puede obtener al configurar el Canal del Proyecto - véase el párrafo Configuración del canal del Agente en la Plataforma.

1. Establezca el enlace al webhook recibido al configurar el canal del agente en la Plataforma en el campo Enlace a API externa, guarde los datos y reciba un token de autorización. Utilice el token para completar la configuración del canal del agente.

Esto completa la configuración del Bot en Webim.

Configuración del canal del proyecto en la plataforma

Es necesario crear y configurar un canal de proyecto con el conector Webim (Bot API 2.0 externo).

1. Vaya a la pestaña Canales del proyecto.

1. Pulse el botón Crear canal.

1. Se abrirá el panel de selección de canal final.

1. Seleccione Webim (External Bot API 2.0).

2. Se abrirá el panel de creación del Canal Proyecto.

1. Opcionalmente, introduzca un título para este Canal de Proyectos en el campo Nombre con el marcador de posición Nuevo canal.

⁠7. Introduzca la dirección de su cuenta en el campo Webim (External Bot API 2.0) webhook URL como https://<some-name>.webim.ru/api/bot/v2 donde <some-name> es el subdominio que ha establecido en la configuración de la cuenta Webim.

⁠8. Establezca el token obtenido en la configuración del bot Webim en el campo token Webim (API de bot externo 2.0).

⁠9. Copie el enlace webhook del campo URL webhook Chatbot y péguelo en el campo Enlace API externo en la configuración del bot en Webim.

1. Para guardar el Canal Proyecto sin activarlo, pulse el botón CREAR.

1. Para guardar y activar el Canal Proyecto, haga clic en el botón CREAR Y ACTIVAR.

a. El Canal Proyecto se guardará y activará si:

i. Se publica el proyecto;

ii. El token en el campo token Webim (External Bot API 2.0) es único (no hay canales activos del mismo tipo con el mismo token);

iii. La dirección del canal es accesible;

iv. El webhook del canal se ha registrado correctamente.

b. El Canal Proyecto se guardará pero no se activará si no se cumplen una o varias condiciones.

1. Para cancelar la creación del Canal Proyecto, pulse el botón CANCELAR.

Editar y eliminar el canal del proyecto

Para editar un Canal de Proyectos, haga clic en su ficha en la lista de Canales de Proyectos.

1. Para editar cualquier campo, haga clic en él e introduzca un nuevo valor.

2. Para aplicar los cambios a un Canal Proyecto activado, pulse el botón APLICAR.

a. Los cambios se aplicarán si:

i. Se publica el proyecto;

ii. El token en el campo token Webim (External Bot API 2.0) es único (no hay canales activos del mismo tipo con el mismo token);

iii. La dirección del canal es accesible;

iv. El webhook del canal se ha registrado correctamente.

b. Los cambios no se aplicarán si no se cumplen una o varias condiciones.

1. Para desactivar el Canal Proyecto, pulse el botón DESACTIVAR.

1. Para aplicar los cambios a un Canal Proyecto no activado, pulse el botón GUARDAR.

1. Para aplicar los cambios y activar el Canal Proyecto, pulse el botón GUARDAR Y ACTIVAR.

a. Los cambios se aplicarán y el Canal Proyecto se activará si:

i. Se publica el proyecto;

ii. El token en el campo token Webim (External Bot API 2.0) es único (no hay canales activos del mismo tipo con el mismo token);

iii. La dirección del canal es accesible;

iv. Se puede registrar el webhook del canal.

b. Los cambios se aplicarán pero el Canal Proyecto no se activará si no se cumplen una o varias condiciones.

1. Para cancelar los cambios, pulse el botón CANCELAR.

1. Para eliminar el Canal Proyecto, pulse el botón ELIMINAR.

⁠Comunicación

La interacción con este Canal Final se produce mediante un método síncrono, utilizando Webim External Bot API 2.0.

Dado que el Canal Final es síncrono, la Conversación ocurre de acuerdo al esquema Solicitud de Webim - Respuesta del Agente, esto impone algunas restricciones y características en la Conversación:

1. Para transferir a un operador utilizando el Modo Cambiar Chat, esta Ranura debe estar después de la Ranura Esperar Reacción: en respuesta a una Respuesta con un mensaje del Usuario Bot, se enviará una Respuesta con un comando de control para transferir el Diálogo al operador.

2. El Agente sólo puede responder a mensajes, pero no puede ser el primero en enviar mensajes al Chat de este Canal Final a través del Timer Slot o Incoming Request Slot, ya que en este caso no habrá ninguna Solicitud de Webim a la que se pueda dar una Respuesta.

Importante: cuando se activa el Temporizador o la Ranura de Solicitud Entrante, el Agente iniciará la Rama de Script correspondiente y seguirá el Script, deteniéndose en la Ranura de Espera de Entrada, mientras que los mensajes enviados antes de esta Ranura no se entregarán realmente al Agente.

Cambiar a un operador si no hay respuesta del Agente

Si se produce algún error en una solicitud de API (la respuesta difiere de la esperada o la solicitud se cerró tras un tiempo de espera de 5 segundos), el chat se transfiere automáticamente a la cola general de operadores.

Asignación de variables de canal de Webim 2

Canal variable	Canal final	Variable en el cuerpo de una solicitud entrante de un canal	Peculiaridades
channel_conversation_id	Webim (External Bot API 2.0)	chat.id
channel_visitor_id	Webim (External Bot API 2.0)	visitor.id
channel_visitor_firstname	Webim (External Bot API 2.0)	visitor.fields.name
channel_visitor_lastname	Webim (External Bot API 2.0)	No
channel_visitor_account	Webim (External Bot API 2.0)	visitor.fields.login
channel_visitor_phone	Webim (External Bot API 2.0)	visitor.fields.phone
channel_visitor_email	Webim (External Bot API 2.0)	visitor.fields.email
channel_visitor_source	Webim (External Bot API 2.0)	visitor.fields.site
channel_reply_to	Webim (External Bot API 2.0)	no

Comunicación en Webim 2.0

Funcionalidad	Canal	Disponibilidad	Descripción
channel_chat_id	Webim (External Bot API 2.0)	Si	el formato es |omnichannel porque se utiliza Omnichannel Connector
Los mensajes llegarán al Usuario Bot si el Agente escribe primero en un chat existente	Webim (External Bot API 2.0)	Si
Botones	Webim (External Bot API 2.0)	Si	el clic del botón se convierte en texto de la etiqueta del botón
Transferencia al operador	Webim (External Bot API 2.0)	No
Transferencia de archivos como archivos del Agente	Webim (External Bot API 2.0)	No	En WhatsApp a través de Webim: si el bot envió botones al usuario del bot, Webim los convertirá en una lista numerada y procesará únicamente la introducción del número de elemento; no se procesará la introducción de una etiqueta de botón u otro texto: Webim no aceptará otros caracteres/texto.
Transferencia de archivos como enlaces desde el Agente	Webim (External Bot API 2.0)	Si	La transferencia a un operador a través del modo de chat de cambio no se admite en la implementación actual de la funcionalidad de la Plataforma. La transferencia al operador se puede realizar "manualmente" a través de Solicitud Externa
Recepción de un archivo del Usuario Bot en un script	Webim (External Bot API 2.0)	Si
Entrega de mensajes de más de 1000 caracteres del Agente al Usuario Bot	Webim (External Bot API 2.0)	Si
Uso de Markdown	Webim (External Bot API 2.0)	No
Envío con notificación	Webim (External Bot API 2.0)	No