Custom OTP Code Delivery - Secure Transmission and Best Practices

Si prefiere generar usted mismo el código de verificación en lugar de utilizar la plataforma de EngageLab, puede llamar a esta API.

Esta API se utiliza específicamente para enviar códigos de verificación generados previamente y no generará los códigos por sí misma. Después de enviar el código de verificación, no es necesario llamar a la API de verificación para validarlo.

Si prefiere que la plataforma de EngageLab genere el código de verificación, puede llamar a la API de envío de OTP de EngageLab.

Endpoint

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

Autenticación

Se utiliza HTTP Basic Authentication para la verificación. Añadir un 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/codes  HTTP/1.1  
Content-Type: application/json  
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Cuerpo de la solicitud

              
              {
    "to": "+8618701235678",
    "code": "398210", 
    "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 preconfigurados como from_id, si no se pasa el valor del campo param_vars, el mensaje utilizará el from_id preconfigurado de la plantilla durante el envío;
2. Si se pasan valores del campo param_vars, como param_vars:{"from_id":"12345"}, durante el envío, el from_id de la plantilla se sustituirá por 12345;
3. De forma similar, para campos de variables personalizados en el contenido de la plantilla creada, asignar valores mediante param_vars; p. ej., para el contenido de plantilla Hi {{name}}, your verify code is {{code}}, 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 devuelto de send_channel 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 conmutar de WhatsApp a SMS en caso de fallo de entrega, la respuesta de la API mostrará 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