Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt

Use this file to discover all available pages before exploring further.

La cabecera X-Jelou-Signature es obligatoria.

Descripción

Envía un mensaje al usuario final a través de Jelou. El cliente ejecuta este recurso para notificar a Jelou que debe entregar un mensaje al usuario final activo en la conversación. Jelou validará la firma del request, procesará el contenido y lo entregará al usuario a través del canal configurado (por ejemplo, WhatsApp).

Endpoint

POST https://chatbot.jelou.ai/v1/external-support/webhook

Parámetros del cuerpo

field
string
requerido
Tipo de campo del evento. Valor fijo: messages.
object
string
requerido
Tipo de objeto del evento. Valor fijo: message_event.
event_type
string
requerido
Tipo de evento. Valor fijo: incoming_message.
project_id
string
requerido
Identificador del proyecto de Jelou al que pertenece la conversación.
room_id
string
requerido
Identificador de la sala de conversación activa.
bot_id
string
requerido
Identificador del bot de Jelou asociado a la conversación.
user_id
string
requerido
Identificador del usuario final que recibirá el mensaje.
value
object
requerido
Contenido del mensaje a entregar al usuario final.
  • id — Identificador único del mensaje.
  • type — Tipo de mensaje: text, image, video, audio, document.
  • content — Objeto con el contenido según el tipo (ver tabla de tipos al final de esta página).

Autenticación

Este recurso valida la cabecera X-Jelou-Signature.

Ejemplo de solicitud

El siguiente ejemplo envía un mensaje de texto al usuario final a través de Jelou:
cURL
curl --request POST \
  --url https://chatbot.jelou.ai/v1/external-support/webhook \
  --header 'Content-Type: application/json' \
  --header 'X-Jelou-Signature: sha256=HMAC_SIGNATURE' \
  --data '{
    "field": "messages",
    "object": "message_event",
    "event_type": "incoming_message",
    "project_id": "PROJECT_ID",
    "room_id": "ROOM_ID",
    "bot_id": "BOT_ID",
    "user_id": "USER_ID",
    "value": {
      "id": "MESSAGE_ID",
      "type": "text",
      "content": {
        "body": "Hola usuario, ¿en qué puedo ayudarte?"
      }
    }
  }'

Respuestas

CódigoEstadoDescripción
200OKMensaje recibido y procesado por Jelou.
500Internal Server ErrorError interno del servidor.

Tipos de mensajes soportados

TipoCampo value.contentCampos adicionales
text{ "body": "Texto del mensaje" }
image{ "url": "...", "mime_type": "image/jpeg" }caption (opcional)
video{ "url": "...", "mime_type": "video/mp4" }caption (opcional)
audio{ "url": "...", "mime_type": "audio/mpeg" }
document{ "url": "...", "mime_type": "application/pdf" }filename (opcional)
Las URLs de archivos multimedia deben ser accesibles vía HTTPS.