Gateway de SMS

Início rápido de SMS

Envie códigos OTP, alertas e SMS transacionais para mais de 190 países. Cada mensagem devolve um aviso de entrega, para saber que chegou.

Quer testar sem SMS reais? Use o Modo sandbox — nenhuma mensagem real enviada, códigos OTP previsíveis e sem faturação.

1Enviar um SMS

Faça POST do número do destinatário e do texto da mensagem. O campo from define o Sender ID visível para o utilizador (o suporte das operadoras varia por país).

POST/api/v1/connect-hub/sms

bash

curl -X POST https://api.novauth.com/api/v1/connect-hub/sms \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-account-id: YOUR_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "to":   "+14155552671",
    "text": "Your verification code is 482951. Valid for 10 minutes.",
    "from": "Novauth"
  }'

200 OK — Resposta

json

{
  "messageId": "a3f2c1d0-4e5b-6c7d-8e9f-0a1b2c3d4e5f",  // save for delivery check
  "from":      "Novauth",
  "to":        "+14155552671"
}

Comprimento do texto: as mensagens SMS estão limitadas a 160 caracteres por segmento. São aceites mensagens até 4 096 caracteres — são divididas automaticamente em segmentos concatenados e remontadas no telefone.

2Verificar o estado de entrega

Consulte o endpoint de SDR (SMS Delivery Report) para confirmar que a mensagem chegou ao telefone. Verifique pouco depois do envio — a entrega típica demora menos de 5 segundos.

GET/api/v1/connect-hub/sms/{messageId}/sdr

bash

curl https://api.novauth.com/api/v1/connect-hub/sms/a3f2c1d0-.../sdr \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-account-id: YOUR_ACCOUNT_ID"

3Comunicar o resultado da verificação

Assim que o utilizador submeter o código recebido, faça POST do resultado para o endpoint de webhook, para fechar o registo do SMS e registar o resultado.

POST/api/v1/connect-hub/sms/webhook

bash

# Report the verification outcome from your backend
curl -X POST https://api.novauth.com/api/v1/connect-hub/sms/webhook \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-account-id: YOUR_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "id":     "a3f2c1d0-...",
    "status": "Success"
  }'

Referência da API

POST/smsEnviar uma mensagem SMS

GET/sms/{messageId}/sdrObter relatório de entrega do SMS

POST/sms/webhookComunicar o resultado da verificação

POST/sms/sdrListar todos os registos de SMS (paginado)

Corpo do pedido — POST /sms

tostringrequiredTelefone do destinatário em formato E.164

textstringrequiredConteúdo da mensagem (1–4 096 caracteres)

fromstringoptionalSender ID ou número (dependente da operadora)

Listar todos os registos de SMS

bash

# Paginated list of all SMS records
curl -X POST https://api.novauth.com/api/v1/connect-hub/sms/sdr \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-account-id: YOUR_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 1,
    "rows_per_page": 20,
    "sort_by": "created_at",
    "sort_direction": "DESC"
  }'