Envío de código OTP personalizado

Si quieres generar tú mismo los códigos de verificación, en lugar de que los genere la plataforma EngageLab, puedes llamar a esta API.

Esta API se utiliza específicamente para enviar códigos de verificación pregenerados y no genera códigos de verificación por sí sola. Después de enviar un código de verificación, no es necesario llamar a una API de verificación para validarlo.

Si quieres que la plataforma EngageLab genere los códigos de verificación, puedes llamar a la API EngageLab OTP Verification Code Delivery.

Endpoint

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

Autenticación

Utiliza autenticación básica HTTP añadiendo Authorization a la cabecera HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

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

Ejemplo de solicitud

Cabecera de la solicitud

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

            

Cuerpo de la solicitud

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

Descripción de params

1. Para campos de plantilla predefinidos como from_id, si no se proporciona el valor del campo param_vars, se utilizará el from_id predefinido en la plantilla cuando se envíe el mensaje.
2. Si se proporciona el valor del campo param_vars, como param_vars:{"from_id":"12345"}, entonces el from_id de la plantilla se sustituirá por 12345 cuando se envíe el mensaje.
3. Los campos de variables personalizadas en el contenido de la plantilla creados durante la creación de la plantilla también reciben valores mediante param_vars. Por ejemplo, si el contenido de la plantilla es Hi {{name}}, your verify code is {{code}}, entonces se requiere 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 representa el canal que se está utilizando actualmente. Por ejemplo, si la estrategia de la plantilla está configurada para que el envío a través del canal de WhatsApp vuelva a intentarse automáticamente a través del canal SMS en caso de fallo, la respuesta de la API devolverá el valor whatsapp. Tras un determinado periodo de tiempo, si se detecta un fallo en la 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