Skip to main content
Evolution Bot es una integración de chatbot universal que permite la utilización de cualquier URL de API o automatización para crear interacciones automatizadas. Al utilizar Evolution Bot, su API debe retornar la respuesta en forma de un JSON conteniendo el campo message, que será enviado de vuelta al usuario. Este sistema ofrece flexibilidad para construir chatbots que se integran perfectamente con sus APIs personalizadas.

​
1. Creación de Bots en Evolution Bot

Puede configurar bots en Evolution Bot utilizando triggers para iniciar las interacciones. La configuración del bot puede realizarse a través del endpoint /evolutionBot/create/{{instance}}.

​
Endpoint para Creación de Bots

​
Endpoint

​
Cuerpo de la Solicitud

Aquí hay un ejemplo de cuerpo JSON para configurar un bot en Evolution Bot:

​
Explicación de los Parámetros

  • enabled: Activa (true) o desactiva (false) el bot.
  • apiUrl: URL de la API que será llamada por el bot (sin la / al final).
  • apiKey: Clave de la API proporcionada por su aplicación (opcional).
  • Opciones:
    • triggerType: Tipo de trigger para iniciar el bot (all o keyword).
    • triggerOperator: Operador utilizado para evaluar el trigger (contains, equals, startsWith, endsWith, regex, none).
    • triggerValue: Valor utilizado en el trigger (por ejemplo, una palabra clave o regex).
    • expire: Tiempo en minutos después del cual el bot expira, reiniciándose si la sesión expiró.
    • keywordFinish: Palabra clave que finaliza la sesión del bot.
    • delayMessage: Retraso (en milisegundos) para simular la escritura antes de enviar un mensaje.
    • unknownMessage: Mensaje enviado cuando la entrada del usuario no es reconocida.
    • listeningFromMe: Define si el bot debe escuchar los mensajes enviados por el propio usuario (true o false).
    • stopBotFromMe: Define si el bot debe detenerse cuando el propio usuario envía un mensaje (true o false).
    • keepOpen: Mantiene la sesión abierta, evitando que el bot sea reiniciado para el mismo contacto.
    • debounceTime: Tiempo (en segundos) para juntar varios mensajes en uno solo.
    • ignoreJids: Lista de JIDs de contactos que no activarán el bot.

​
Ejemplo de Retorno de la API

La respuesta de su API debe estar en formato JSON y contener el mensaje a enviar al usuario en el campo message:

​
2. Configuraciones Predeterminadas de Evolution Bot

Puede definir configuraciones predeterminadas que se aplicarán en caso de que los parámetros no sean proporcionados durante la creación del bot.

​
Endpoint para Configuraciones Predeterminadas

​
Endpoint

​
Cuerpo de la Solicitud

Aquí hay un ejemplo de configuración predeterminada:

​
Explicación de los Parámetros

  • expire: Tiempo en minutos después del cual el bot expira.
  • keywordFinish: Palabra clave que finaliza la sesión del bot.
  • delayMessage: Retraso para simular la escritura antes de enviar un mensaje.
  • unknownMessage: Mensaje enviado cuando la entrada del usuario no es reconocida.
  • listeningFromMe: Define si el bot debe escuchar los mensajes enviados por el propio usuario.
  • stopBotFromMe: Define si el bot debe detenerse cuando el propio usuario envía un mensaje.
  • keepOpen: Mantiene la sesión abierta, evitando que el bot sea reiniciado para el mismo contacto.
  • debounceTime: Tiempo para juntar varios mensajes en uno solo.
  • ignoreJids: Lista de JIDs de contactos que no activarán el bot.
  • evolutionBotIdFallback: ID del bot de respaldo que se utilizará en caso de que ningún trigger sea activado.

​
3. Gestión de Sesiones de Evolution Bot

Puede gestionar las sesiones del bot, cambiando el estado entre abierta, pausada o cerrada para cada contacto específico.

​
Endpoint para Gestión de Sesiones

​
Endpoint

​
Cuerpo de la Solicitud

Aquí hay un ejemplo de cómo gestionar el estado de la sesión:

​
Explicación de los Parámetros

  • remoteJid: JID (identificador) del contacto en WhatsApp.
  • status: Estado de la sesión (opened, paused, closed).

​
4. Variables Automáticas y Especiales en Evolution Bot

Cuando se inicia una sesión de Evolution Bot, algunas variables predefinidas se envían automáticamente:

​
Explicación de las Variables Automáticas

  • remoteJid: JID del contacto con quien el bot está interactuando.
  • pushName: Nombre del contacto en WhatsApp.
  • instanceName: Nombre de la instancia que está ejecutando el bot.
  • serverUrl: URL del servidor donde la Evolution API está alojada.
  • apiKey: Clave de API usada para autenticar las solicitudes.

​
Consideraciones Finales

Evolution Bot ofrece una plataforma flexible para la integración de chatbots con sus APIs personalizadas, permitiendo automatización avanzada e interacciones personalizadas en WhatsApp. Con el soporte para triggers, gestión de sesiones y configuración de variables automáticas, puede construir una experiencia de chatbot robusta y eficaz para sus usuarios.