OpenAI

​

1. Creación de Credenciales de OpenAI

​

Endpoint para Creación de Credenciales

​

Endpoint

POST {{baseUrl}}/openai/creds/{{instance}}

​

Cuerpo de la Solicitud

{
    "name": "apikey",
    "apiKey": "sk-proj-..."
}

​

Explicación de los Parámetros

• name: Nombre identificador de la credencial.
• apiKey: Clave de la API proporcionada por OpenAI.

​

2. Creación de Bots con OpenAI

​

Endpoint para Creación de Bots

​

Endpoint

POST {{baseUrl}}/openai/create/{{instance}}

​

Cuerpo de la Solicitud

{
    "enabled": true,
    "openaiCredsId": "clyrx36wj0001119ucjjzxik1",
    "botType": "assistant",
    // para asistentes
    "assistantId": "asst_LRNyh6qC4qq8NTyPjHbcJjSp",
    "functionUrl": "https://n8n.site.com",
    // para chat completion
    "model": "gpt-4",
    "systemMessages": [
        "You are a helpful assistant."
    ],
    "assistantMessages": [
        "\n\nHello there, how may I assist you today?"
    ],
    "userMessages": [
        "Hello!"
    ],
    "maxTokens": 300,
    // opciones
    "triggerType": "keyword",
    "triggerOperator": "equals",
    "triggerValue": "test",
    "expire": 20,
    "keywordFinish": "#SALIR",
    "delayMessage": 1000,
    "unknownMessage": "Mensaje no reconocido",
    "listeningFromMe": false,
    "stopBotFromMe": false,
    "keepOpen": false,
    "debounceTime": 10,
    "ignoreJids": []
}

​

Explicación de los Parámetros

• enabled: Activa (true) o desactiva (false) el bot.
• openaiCredsId: ID de la credencial registrada anteriormente.
• botType: Tipo del bot (assistant o chatCompletion).
  • Para Asistentes (assistant):
    • assistantId: ID del asistente OpenAI.
    • functionUrl: URL que será llamada en caso de que el asistente necesite realizar una acción.
  • Para Chat Completion (chatCompletion):
    • model: Modelo de OpenAI a utilizar (ej.: gpt-4).
    • systemMessages: Mensajes que configuran el comportamiento del bot.
    • assistantMessages: Mensajes iniciales del bot.
    • userMessages: Mensajes de ejemplo del usuario.
    • maxTokens: Número máximo de tokens utilizados en la respuesta.
• 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.

​

3. Gestión de Sesiones de OpenAI

​

Endpoint para Gestión de Sesiones

​

Endpoint

POST {{baseUrl}}/openai/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. Configuraciones Predeterminadas de OpenAI

​

Endpoint para Configuraciones Predeterminadas

​

Endpoint

POST {{baseUrl}}/openai/settings/{{instance}}

​

Cuerpo de la Solicitud

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

​

Explicación de los Parámetros

• openaiCredsId: ID de la credencial de OpenAI a usar como predeterminada.
• 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.
• openaiIdFallback: ID del bot de respaldo que se utilizará en caso de que ningún trigger sea activado.
• speechToText: Define si la funcionalidad de reconocimiento de voz (speech-to-text) debe activarse usando la credencial definida por defecto.

​

Webhook con speechToText

​

Ejemplo de Webhook con speechToText

{
    "event": "message",
    "data": {
        "message": {
            "id": "message-id",
            "from": "sender-number",
            "to": "receiver-number",
            "content": "Text message",
            "speechToText": "This is the transcribed text from the audio."
        }
    }
}

​

Consideraciones Finales