Entrega de mensajes personalizados

Si has creado contenido de plantilla personalizado en la plataforma OTP, llama a esta API para enviar mensajes personalizados.

Endpoint

POST https://otp.api.engagelab.cc/v1/custom-messages

Autenticación

Usa la autenticación básica HTTP y añade Authorization a la cabecera HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

El algoritmo de generación de base64_auth_string es: base64(dev_key:dev_secret).

Formato de la solicitud

Cabeceras de la solicitud

              
              POST /v1/custom-messages HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Cuerpo de la solicitud

              
              {
  "to": "+6591234567",
  "template": {
    "id": "test-template-1",
    "params": {
      "code": "codevalue",
      "var1": "value1"
    }
  }
}

            

Parámetros de la solicitud

Un objeto de solicitud se expresa en formato JSON, por lo que la cabecera de la solicitud debe incluir Content-Type: application/json.

Notas sobre params

1. Para variables de plantilla predefinidas como {{brand_name}}, {{ttl}} y {{pwa_url}}, no es necesario enviarlas. El sistema las sustituye automáticamente por el contenido especificado al crear la plantilla.
2. Si el tipo de plantilla es un código de verificación, debes enviar la variable {{code}}; de lo contrario, se devolverá un error.
3. Si el contenido de la plantilla contiene campos de variables personalizadas definidos al crearla, asígnales también valores mediante params. Por ejemplo, para el contenido de plantilla Hi {{name}}, your verify code is {{code}}, debes asignar el parámetro params: {"name":"Bob"}.

Ejemplos de solicitud

1. Enviar un código de verificación personalizado

              
              {
  "to": "+6591234567",
  "template": {
    "id": "code-template",
    "params": {
      "code": "123456"
    }
  }
}

            

2. Enviar contenido de notificación personalizado

              
              {
  "to": "+6591234567",
  "template": {
    "id": "notification-template",
    "params": {
      "order": "123456"
    }
  }
}

            

3. Enviar contenido de marketing personalizado

              
              {
  "to": ["+6591234567"],
  "template": {
    "id": "marketing-template",
    "params": {
      "name": "EngageLab",
      "promotion": "30%"
    }
  }
}

            

Parámetros de respuesta

Respuesta correcta

              
              {
  "message_id": "1725407449772531712",
  "send_channel": "sms"
}

            

Ten en cuenta que el valor de send_channel devuelto no representa el canal final utilizado para entregar el mensaje al usuario. Solo indica el canal que se está utilizando en ese momento. Por ejemplo, si la estrategia configurada en la plantilla especifica que, cuando falle la entrega por WhatsApp, debe reintentarse automáticamente a través del canal SMS, la respuesta de la API devolverá whatsapp. Después, cuando se detecte el fallo de entrega tras un cierto periodo de tiempo, el sistema enviará el mensaje a través del canal SMS.

Respuesta fallida

El código de estado HTTP es 4xx o 5xx, y el cuerpo de la respuesta contiene los siguientes campos:

              
              {
  "code": 5001,
  "message": "sms send fail"
}

            

Códigos de error