Sending OTP Codes Securely - Explore Delivery Methods and Best Practices

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

Si se prefiere generar el código de verificación internamente en lugar de usar la plataforma EngageLab, se puede llamar a la API de envío de OTP personalizado (Custom OTP Send) de EngageLab.

Endpoint

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

Autenticación

Se utiliza HTTP Basic Authentication para la verificación. Añadir Authorization en el encabezado HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

El algoritmo de generación del valor anterior base64_auth_string es: base64(dev_key:dev_secret)

Ejemplo de solicitud

Encabezado de solicitud

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

            

Cuerpo de la solicitud

              
              {
    "to": "+8618701235678",
    "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 el encabezado de la solicitud debe incluir Content-Type: application/json.

Notas sobre params

1. Para plantillas con campos preestablecidos como from_id, si no se pasa el valor del campo param_vars, durante el envío el mensaje utilizará el from_id preestablecido de la plantilla.
2. Si se pasan valores del campo param_vars, como param_vars:{"from_id":"12345"}, entonces, durante el envío, el from_id de la plantilla se reemplazará por 12345.
3. Del mismo modo, para campos de variables personalizadas en el contenido de la plantilla creada, se deben asignar valores mediante param_vars; p. ej., para el contenido de plantilla Hi {{name}}, your verify code is {{code}}, se deben asignar parámetros con param_vars:{"name":"Bob"}.

Parámetros de la respuesta

Respuesta correcta

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

            

Se debe tener en cuenta que el valor send_channel devuelto no representa el canal de entrega final al usuario, sino únicamente el canal de la fase actual. Por ejemplo, si la estrategia de la plantilla está configurada para cambiar de WhatsApp a SMS cuando la entrega falla, la API devolverá inicialmente whatsapp y, posteriormente, si se detecta un fallo de entrega, el sistema utilizará el canal SMS para el envío.

Respuesta de error

Código de estado HTTP 4xx o 5xx; el cuerpo de la respuesta incluye los siguientes campos:

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

            

Códigos de error