API Verificar OTP

Verifica la validez del código de paso único (OTP) que un usuario ha proporcionado. Por favor, lee la Referencia General de la API antes de leer este documento.

Después de utilizar la API de Enviar OTP para enviar un código de verificación al usuario, puedes verificar rápidamente si el código proporcionado es correcto simplemente enviando el código recibido y el número de teléfono del usuario, sin necesidad de almacenar ningún dato.

Definiciones

Acción: otp.verify
Método HTTP: POST
Content-Type: application/json

Parámetros de la solicitud

Nombre	Tipo	Requerido	Descripción	Ejemplo
to	string	Sí	Número de teléfono del usuario para la verificación. Usando formato E.164.	+12068800123
code	string	Sí	Código para la verificación. Debe ser una cadena de 4-8 dígitos.	123456
intent	string	No	Intención del usuario para la verificación, debe ser la misma que la pasada con la API de Enviar OTP. Máximo 36 caracteres.	login
ttl	integer	No	Tiempo de vida del código en segundos. Máx: `1800`. Predeterminado: `300` (5 minutos) * Solo aplicable a códigos OTP generados automáticamente, no afecta a códigos personalizados.	300

Ejemplo de solicitud

El siguiente ejemplo verificará y devolverá si el código de verificación proporcionado por el usuario es correcto.

curl -X POST 'https://api.unimtx.com/?action=otp.verify&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+120688001xx",
  "code": "123456"
}'

Parámetros de respuesta

Nombre	Tipo	Descripción	Ejemplo
code	string	Código de retorno	0
message	string	Mensaje de retorno	Éxito
data	JSON	Resultados

Resultados `data`

Nombre	Tipo	Descripción	Ejemplo
to	string	Número de teléfono del usuario (E.164)	+12068800123
valid	boolean	Indica si el código proporcionado es válido	true

Ejemplos de respuesta

Ejemplo de respuesta exitosa

Código de estado: 200, Cuerpo de la respuesta:

{
  "code": "0",
  "message": "Success",
  "data": {
    "to": "+12068800123",
    "valid": true
  }
}

Ejemplo de respuesta fallida

Código de estado: 400, Cuerpo de la respuesta:

{
  "code": "104001",
  "message": "MissingParams"
}