Entrega de OTP

Esta API genera códigos de verificación a través de la plataforma EngageLab y los entrega según la estrategia de canal especificada en la plantilla.

Si quieres generar los códigos de verificación tú mismo en lugar de usar la plataforma EngageLab, puedes llamar a la API EngageLab OTP Custom Verification Code Delivery.

Endpoint

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

Autenticación

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

              
              Authorization: Basic ${base64_auth_string}

            

El algoritmo para generar base64_auth_string es: base64(dev_key:dev_secret)

Ejemplo de solicitud

Cabecera de la solicitud

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

            

Cuerpo de la solicitud

              
              {
  "to": "+6591234567",
  "template": {
    "id": "test-template-1",
    "language": "default",
    "params": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

            

Parámetros de la solicitud

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

Notas sobre params

1. Para los campos predefinidos en la plantilla, como from_id, si no se proporciona el valor del campo param_vars, se utilizará el from_id predefinido de la plantilla al entregar el mensaje.
2. Si se proporciona el valor del campo param_vars, por ejemplo, param_vars:{"from_id":"12345"}, el from_id de la plantilla se sustituirá por 12345 cuando se entregue el mensaje.
3. Del mismo modo, los campos de variables personalizadas del contenido de la plantilla definidos durante su creación también se asignan mediante param_vars. Por ejemplo, si el contenido de la plantilla es Hi {{name}}, your verify code is {{code}}, se requerirá el parámetro de asignación param_vars:{"name":"Bob"}.

Parámetros de respuesta

Respuesta correcta

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

            

Ten en cuenta que el valor 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 de la plantilla está configurada para que, si falla la entrega a través del canal de WhatsApp, se reintente automáticamente a través del canal SMS, la respuesta de la API devolverá el valor whatsapp. Transcurrido un cierto tiempo, una vez detectado el fallo de entrega, 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