Typebot

​

1. Configuración de Bots en Typebot

​

Endpoint para Configuración de Bots

​

Endpoint

POST {{baseUrl}}/typebot/create/{{instance}}

​

Cuerpo de la Solicitud

{
    "enabled": true,
    "url": "https://bot.dgcode.com.br",
    "typebot": "my-typebot-uoz1rg9",
    "triggerType": "keyword",
    "triggerOperator": "regex",
    "triggerValue": "^atend.*",
    "expire": 20,
    "keywordFinish": "#SALIR",
    "delayMessage": 1000,
    "unknownMessage": "Mensaje no reconocido",
    "listeningFromMe": false,
    "stopBotFromMe": false,
    "keepOpen": false,
    "debounceTime": 10
}

​

Explicación de los Parámetros

• enabled: Activa (true) o desactiva (false) el bot.
• url: URL de la API de Typebot (sin la / al final).
• typebot: Nombre público del bot en Typebot.
• triggerType: Tipo de trigger para iniciar el bot (keyword, all, none).
• triggerOperator: Operador utilizado para evaluar el trigger (contains, equals, startsWith, endsWith, regex).
• 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, cuando es recibida, 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.

​

2. Gestión de Sesiones de Typebot

​

Endpoint para Gestión de Sesiones

​

Endpoint

POST {{baseUrl}}/typebot/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).

​

3. Configuración Predeterminada de Typebot

​

Configuración Predeterminada

{
    "expire": 20,
    "keywordFinish": "#SALIR",
    "delayMessage": 1000,
    "unknownMessage": "Mensaje no reconocido",
    "listeningFromMe": false,
    "stopBotFromMe": false,
    "keepOpen": false,
    "debounceTime": 10,
    "ignoreJids": [],
    "typebotIdFallback": "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 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.
• typebotIdFallback: ID del bot de respaldo que se utilizará en caso de que ningún trigger sea activado.

​

4. Inicialización Activa de un Bot

​

Endpoint para Inicialización Activa

​

Endpoint

POST {{baseUrl}}/typebot/start/{{instance}}

​

Cuerpo de la Solicitud

{
    "url": "https://bot.dgcode.com.br",
    "typebot": "fluxo-unico-3uuso28",
    "remoteJid": "[email protected]",
    "startSession": false,
    "variables": [
        {
            "name": "pushName",
            "value": "Davidson Gomes"
        }
    ]
}

​

Explicación de los Parámetros

• url: URL de la API de Typebot (sin la / al final).
• typebot: Nombre público del bot en Typebot.
• remoteJid: JID (identificador) del contacto en WhatsApp.
• startSession: Define si la sesión debe iniciarse con el bot (true o false).
• variables: Variables personalizadas que pueden pasarse al bot (por ejemplo, nombre del usuario).

​

Variables Predefinidas

const prefilledVariables = {
    remoteJid: "JID del contacto",
    pushName: "Nombre del contacto",
    instanceName: "Nombre de la instancia",
    serverUrl: "URL del servidor de la API",
    apiKey: "Clave de API de Evolution",
    ownerJid: "JID del número conectado a la instancia"
};

​

Explicación de las Variables Predefinidas

• 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.
• ownerJid: JID del número de teléfono conectado a la instancia.

​

Interacción con Variables Pasadas en startTypebot

​

Consideraciones Finales