Skip to main content

​
Envío de Campañas por HSM

Las plantillas (HSM) te permiten enviar mensajes preaprobados, ideal para campañas de mensajes masivos, notificaciones, y seguimientos automatizados.

​
Prerrequisitos

  • Debes tener una plantilla aprobada en Jelou y su templateId.
  • El usuario debe estar incluido en la campaña.
  • Es necesario el botId y campaignId válidos.
  • Obtén tus credenciales de API (clientId y clientSecret).

​
Endpoint

https://api.jelou.ai/v1/bots/{botId}/campaigns/{campaignId}/template-messages

​
Autenticación

​
Authorization
string
required
Encabezado de autenticación en formato Basic <base64(clientId:clientSecret)>.

​
Parámetros de Ruta

​
botId
string
required
Identificador único del bot emisor.
​
campaignId
string
required
Identificador único de la campaña.

​
Cuerpo de la solicitud

​
type
string
required
Debe ser "template".
​
templateId
string
required
ID de la plantilla aprobada por WhatsApp a utilizar.
​
userId
string
required
Identificador único del usuario que recibirá el mensaje.
​
parameters
object
Valores a sustituir en los campos dinámicos de la plantilla.
Ejemplo: {"nombre": "Ana", "codigo": "XYZ987"}
​
botId
string
Opcional. Si se incluye en el cuerpo, debe coincidir con el valor de la ruta.

​
Ejemplo de solicitud

cURL
curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/campaigns/CAMPAIGN_ID/template-messages \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "template",
    "templateId": "tpl_bienvenida_123",
    "userId": "user_001",
    "parameters": {
      "nombre": "Ana",
      "codigo": "XYZ987"
    }
  }'

​
Campos de respuesta

​
success
boolean
true si el mensaje fue enviado exitosamente a través de la campaña.
​
messageId
string
Identificador único del mensaje enviado. Úsalo para consultar su estado.

​
Ejemplo de respuesta exitosa

Success
{
  "success": true,
  "messageId": "msg_987654321"
}

​
Manejo de errores

​
error
string
Código de error al enviar el mensaje (ver códigos comunes abajo).
​
message
string
Descripción detallada del error.

​
Códigos de error comunes

  • INVALID_TEMPLATE — La plantilla no existe o no es apta para campañas.
  • INVALID_PARAMETERS — Faltan o sobran parámetros requeridos por la plantilla.
  • UNAUTHORIZED — Credenciales inválidas o sin acceso.
  • BOT_NOT_FOUND — El bot especificado no existe.
  • USER_NOT_FOUND — El usuario no existe o está fuera de la campaña.
  • CAMPAIGN_NOT_FOUND — La campaña no existe.
Asegúrate de que los parámetros enviados coincidan exactamente con los que espera la plantilla, de lo contrario el envío fallará.

​
Casos de uso destacados

  • Enviar mensajes de bienvenida personalizados dentro de una campaña de onboarding.
  • Notificar automáticamente a usuarios sobre el avance en un proceso.
  • Realizar recordatorios para eventos o promociones.
  • Promocionar productos o servicios segmentados por campañas específicas.
Utiliza campañas para automatizar mensajes a listas de usuarios usando variables dinámicas, mejorando la relevancia y efectividad de tus comunicaciones.