EvoAI

​

1. Creación de Bots en EvoAI

​

Endpoint para Creación de Bot

​

Endpoint

POST {{baseUrl}}/evoai/create/{{instance}}

​

Cuerpo de la Solicitud

{
    "enabled": true,
    "agentUrl": "http://evoai.site.com/v1",
    "apiKey": "app-123456",
    // opciones
    "triggerType": "keyword", /* all o keyword */
    "triggerOperator": "equals", /* contains, equals, startsWith, endsWith, regex, none */
    "triggerValue": "test",
    "expire": 0,
    "keywordFinish": "#SALIR",
    "delayMessage": 1000,
    "unknownMessage": "Mensaje no reconocido",
    "listeningFromMe": false,
    "stopBotFromMe": false,
    "keepOpen": false,
    "debounceTime": 0,
    "ignoreJids": []
}

​

Explicación de los Parámetros

• enabled: Activa (true) o desactiva (false) el bot.
• agentUrl: URL de la API EvoAI (sin una barra / al final).
• apiKey: Clave de API proporcionada por EvoAI.
• Opciones:
  • triggerType: Tipo de trigger para iniciar el bot (all o keyword).
  • triggerOperator: Operador usado para evaluar el trigger (contains, equals, startsWith, endsWith, regex, none).
  • triggerValue: Valor usado 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 usuario (true o false).
  • stopBotFromMe: Define si el bot debe detenerse cuando el usuario envía un mensaje (true o false).
  • keepOpen: Mantiene la sesión abierta, impidiendo que el bot se reinicie para el mismo contacto.
  • debounceTime: Tiempo (en segundos) para combinar varios mensajes en uno.
  • ignoreJids: Lista de JIDs de contactos que no activarán el bot.

​

2. Configuraciones Predeterminadas de EvoAI

​

Endpoint para Configuraciones Predeterminadas

​

Endpoint

POST {{baseUrl}}/evoai/settings/{{instance}}

​

Cuerpo de la Solicitud

{
    "expire": 20,
    "keywordFinish": "#SALIR",
    "delayMessage": 1000,
    "unknownMessage": "Mensaje no reconocido",
    "listeningFromMe": false,
    "stopBotFromMe": false,
    "keepOpen": false,
    "debounceTime": 0,
    "ignoreJids": [],
    "evoaiIdFallback": "clyja4oys0a3uqpy7k3bd7swe"
}

​

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 usuario.
• stopBotFromMe: Define si el bot debe detenerse cuando el usuario envía un mensaje.
• keepOpen: Mantiene la sesión abierta, impidiendo que el bot se reinicie para el mismo contacto.
• debounceTime: Tiempo para combinar varios mensajes en uno.
• ignoreJids: Lista de JIDs de contactos que no activarán el bot.
• evoaiIdFallback: ID del bot de respaldo que se usará si ningún trigger es activado.

​

3. Gestión de Sesiones de EvoAI

​

Endpoint para Gestión de Sesión

​

Endpoint

POST {{baseUrl}}/evoai/changeStatus/{{instance}}

​

Cuerpo de la Solicitud

{
    "remoteJid": "[email protected]",
    "status": "closed"
}

​

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 en EvoAI

inputs: {
    remoteJid: "JID del contacto",
    pushName: "Nombre del contacto",
    instanceName: "Nombre de la instancia",
    serverUrl: "URL del servidor API",
    apiKey: "Clave de la API Evolution"
};

​

Explicación de las Variables Automáticas

• remoteJid: JID del contacto con el que 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 solicitudes.

​

Consideraciones Finales