API de envío de OTP

Envía un código de un solo uso (OTP) a un usuario. Por favor, lea Referencia general de la API antes de leer este documento.

Utilizando solo el número de teléfono del usuario como el único parámetro en la configuración predeterminada, Unimatrix generará sin problemas un token OTP numérico seguro y enviará automáticamente el mensaje de verificación a través del canal activo actualmente.

Definiciones

Acción: otp.send
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 el código de verificación. Usando el formato E.164.	+12068800123
digits	integer	No	Número de dígitos para el código OTP generado. Debe estar entre 4-8. Predeterminado: `6`	6
intent	string	No	Intención del usuario al solicitar el código de verificación, utilizado para diferenciar diferentes escenarios de autenticación. Máximo 36 caracteres.	login
channel	string	No	Canal de mensajería de verificación a utilizar. Uno de: `sms`, `call`, `whatsapp` o `auto`. Predeterminado: `auto` (SMS tiene prioridad sobre otros canales)	auto
code	string	No	Un código personalizado en lugar de un código OTP generado automáticamente. Debe ser una cadena de 4-8 dígitos. * No recomendado. Usar códigos personalizados puede reducir la seguridad de su programa.	123456
ttl	integer	No	Tiempo de vida del código personalizado en segundos. Máx: `1800`. Predeterminado: `300` (5 minutos)	300

Ejemplo de solicitud

El siguiente ejemplo generará automáticamente un código de verificación y enviará el código al número de teléfono del usuario.

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

Una vez completado el envío de OTP, use la API de verificar OTP para verificar si el código proporcionado por el usuario es correcto.

Parámetros de respuesta

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

Resultados `data`

Nombre	Tipo	Descripción	Ejemplo
id	string	ID del mensaje	e7f51d2e5550131c3acc7fbc84e9901b
to	string	Número de teléfono del usuario (E.164)	+12068800123
iso	string	Código de país (iso2)	US
cc	string	Código de país (prefijo de llamada internacional)	1
parts	integer	Número de partes del mensaje	1
price	string	Monto del consumo	0.018900

Ejemplos de respuesta

Ejemplo de respuesta exitosa

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

{
  "code": "0",
  "message": "Success",
  "data": {
    "id": "e7f51d2e5550131c3acc7fbc84e9901b",
    "to": "+12068800123",
    "iso": "US",
    "cc": "1",
    "parts": 1,
    "price": "0.018900"
  }
}

Ejemplo de respuesta fallida

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

{
  "code": "107111",
  "message": "InvalidPhoneNumbers"
}