API Verificar OTP

Verifique a validade do código de passagem única (OTP) fornecido por um usuário. Por favor, leia Referência Geral da API antes de ler este documento.

Após usar a API Enviar OTP para enviar um código de verificação para o usuário, você pode rapidamente verificar se o código fornecido está correto simplesmente submetendo o código recebido e o número de telefone do usuário, sem a necessidade de armazenar dados em cache.

Definições

Ação: otp.verify
Método HTTP: POST
Content-Type: application/json

Parâmetros de Solicitação

Nome	Tipo	Obrigatório	Descrição	Exemplo
to	string	Sim	Número de telefone do usuário para verificação. Usando formato E.164.	+12068800123
code	string	Sim	Código para verificação. Deve ser uma string de 4-8 dígitos.	123456
intent	string	Não	Intenção do usuário para verificação, deve ser a mesma que a passada com a API Enviar OTP. Máximo de 36 caracteres.	login
ttl	integer	Não	Tempo de vida do código em segundos. Máximo: `1800`. Padrão: `300` (5 minutos) * Apenas aplicável a códigos OTP gerados automaticamente, não afeta códigos personalizados.	300

Exemplo de Solicitação

O seguinte exemplo verificará e retornará se o código de verificação fornecido pelo usuário está correto.

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 Resposta

Nome	Tipo	Descrição	Exemplo
code	string	Código de retorno	0
message	string	Mensagem de retorno	Success
data	JSON	Resultados

Resultados `data`

Nome	Tipo	Descrição	Exemplo
to	string	Número de telefone do usuário (E.164)	+12068800123
valid	boolean	Indica se o código fornecido é válido	true

Exemplos de Resposta

Exemplo de resposta bem-sucedida

Código de Status: 200, Corpo da Resposta:

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

Exemplo de resposta falha

Código de Status: 400, Corpo da Resposta:

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