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.
Usa las notificaciones para obtener directamente el estado de los mensajes enviados.
Te permiten obtener información relevante, como la cantidad de mensajes leídos de tus mensajes individuales, masivos o de tu campaña.
Al utilizar las notificaciones, puedes conocer el comportamiento del usuario y usar esa información para mejorar tu campaña de marketing o elegir un mejor tipo de mensaje para ser más preciso en tus comunicaciones. Puedes obtener información específica de una notificación mediante su ID o todas las notificaciones para llenar tu base de datos o tu Panel de Control.
Obtener Notificaciones
Este endpoint permite obtener notificaciones enviadas previamente.
GET https://api.jelou.ai/v1/external/bots/{botId}/notifications
Parámetros de ruta
| Propiedad | Tipo | Descripción | Requerido |
|---|
| botId | string | ID del bot. | Sí |
Parámetros de consulta
| Propiedad | Tipo | Descripción | Requerido |
|---|
| messageId | string | ID del mensaje. | No |
| campaignId | string | ID de la campaña. | No |
| elementName | string | Nombre del elemento. | No |
| from | date | Fecha de inicio. | No |
| to | date | Fecha de fin. | No |
| limit | number | Límite de paginación (Máx: 50). | No |
| page | number | Número de página (Por defecto: 1). | No |
Ejemplo de solicitud
curl --request GET \
--url 'https://api.jelou.ai/v1/external/bots/BOT_ID/notifications?limit=50&from=2024-01-01&to=2024-12-31&page=1' \
--header 'Authorization: Basic {{Base64EncodedUsername:Password}}'
Lista de estados de mensajes
| Estado | Descripción |
|---|
DELIVERED_CHANNEL | El mensaje fue recibido por WhatsApp. |
DELIVERED_USER | El mensaje fue recibido por el usuario. |
READ | El usuario leyó el mensaje. |
REPLY | El usuario respondió al mensaje. |
CREATED | El mensaje fue recibido por Jelou. |
FAILED | El mensaje no pudo ser entregado. |
Estado de lectura del mensaje
| Estado | Descripción |
|---|
true | El usuario leyó el mensaje. |
false | El usuario no ha leído el mensaje. |
Respuestas de la API
El payload contiene los siguientes campos:
| Propiedad | Descripción |
|---|
| sentStatus | Estado de entrega de la plantilla. |
| createdAt | Fecha de envío del mensaje. |
| deliveryChannelAt | Fecha de entrega al canal WhatsApp. |
| deliveryUserAt | Fecha de entrega del mensaje por parte de WhatsApp. |
| readAt | Fecha de lectura del mensaje por parte del usuario. |
| destination | Número de teléfono del usuario. |
| elementName | Nombre de la plantilla. |
| id | ID del mensaje. |
| error | Motivo del fallo en la entrega de la plantilla (si aplica). |
| reply | Respuesta del usuario (disponible cuando el estado es REPLY). |
Análisis de métricas
Analiza tasas de entrega, lectura y respuesta para optimizar futuras campañas.
- Medir engagement: Calcula el porcentaje de mensajes leídos vs. entregados.
- Identificar problemas: Detecta números inválidos o bloqueados a través de errores
FAILED.
- Optimizar horarios: Analiza timestamps para encontrar los mejores momentos de envío.
- Mejorar contenido: Usa las respuestas (
REPLY) para entender qué mensajes generan más interacción.
