API Enviar OTP

Envie um código de verificação único (OTP) para um usuário. Por favor, leia Referência Geral da API antes de ler este documento.

Usando apenas o número de telefone do usuário como o único parâmetro na configuração padrão, a Unimatrix irá gerar de forma transparente um token OTP numérico seguro e enviar automaticamente a mensagem de verificação através do canal ativo no momento.

Definições

Ação: otp.send
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 o código de verificação. Usando o formato E.164.	+12068800123
digits	integer	Não	Número de dígitos para o código OTP gerado. Deve ser entre 4-8. Padrão: `6`	6
intent	string	Não	Intenção do usuário ao solicitar o código de verificação, usado para diferenciar diferentes cenários de autenticação. Máximo de 36 caracteres.	login
channel	string	Não	Canal de mensagens de verificação a ser usado. Um dos: `sms`, `call`, `whatsapp` ou `auto`. Padrão: `auto` (SMS tem prioridade sobre outros canais)	auto
code	string	Não	Um código personalizado em vez de um código OTP gerado automaticamente. Deve ser uma string de 4-8 dígitos. * Não recomendado. Usar códigos personalizados pode reduzir a segurança do seu programa.	123456
ttl	integer	Não	Tempo de vida do código personalizado em segundos. Máx: `1800`. Padrão: `300` (5 minutos)	300

Exemplo de Solicitação

O exemplo a seguir irá gerar automaticamente um código de verificação e enviar o código para o número de telefone do usuário.

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

Após completar o envio do OTP, use a API Verificar OTP para verificar se o código fornecido pelo usuário está correto.

Parâmetros de Resposta

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

Resultados `data`

Nome	Tipo	Descrição	Exemplo
id	string	ID da Mensagem	e7f51d2e5550131c3acc7fbc84e9901b
to	string	Número de telefone do usuário (E.164)	+12068800123
iso	string	Código do país (iso2)	US
cc	string	Código do país (Prefixo internacional)	1
parts	integer	Número de partes da mensagem	1
price	string	Quantia de consumo	0.018900

Exemplos de Resposta

Exemplo de resposta bem-sucedida

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

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

Exemplo de resposta falha

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

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