Ir para o conteúdo principal
DEVELOPER HUB

Documentação da API BulkSMS

Integre envio de SMS, WhatsApp, Voice OTP e APIs de rede na sua aplicação em minutos. SDKs robustos e REST API de baixa latência.

GET /v1/account

Autenticação

A autenticação da BulkSMS é feita através de chaves de API secretas enviadas no cabeçalho HTTP de cada requisição. Todas as chamadas de API devem ser realizadas sob protocolo HTTPS.

Cabeçalhos Necessários

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
curl -X GET https://api.smsala.com/v1/account \
  -H "Authorization: Bearer YOUR_API_KEY"
POST /v1/messages

API de SMS

Envie mensagens SMS curtas e alertas de segurança (2FA/OTP) para qualquer número do território brasileiro com rotas diretas Tier-1.

Parâmetros da Requisição

CampoTipoObrigatórioDescrição
tostringSimNúmero de destino em formato internacional (E.164), ex: +971501234567.
fromstringSimIdentificador do remetente (Sender ID), até 11 caracteres alfanuméricos.
textstringSimCorpo da mensagem SMS. Máximo de 160 caracteres por segmento.
curl -X POST https://api.smsala.com/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "from": "YourBrand",
    "text": "Your OTP code is 123456"
  }'
POST /v1/whatsapp/messages

API de WhatsApp

Envie mensagens através do canal oficial WhatsApp Business API. Utilize templates aprovados com variáveis customizáveis para maior interação.

Parâmetros da Requisição

CampoTipoObrigatórioDescrição
tostringSimNúmero de destino em formato internacional (E.164), ex: +971501234567.
templatestringSimNome do template pré-aprovado no painel da Meta.
languagestringSimCódigo do idioma do template (ex: 'en', 'pt_BR').
paramsstring[]NãoLista de variáveis dinâmicas em ordem para preencher o template.
curl -X POST https://api.smsala.com/v1/whatsapp/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "template": "otp_verification",
    "language": "en",
    "params": ["123456"]
  }'
POST /v1/verify/send & /check

Verify API (OTP)

Envie e valide tokens temporários (OTP) de verificação. A Verify API lida automaticamente com geração de códigos, tempo de expiração e conferência.

1. Request OTP Code

CampoTipoObrigatórioDescrição
tostringSimNúmero de destino em formato internacional (E.164), ex: +971501234567.
channelstringSimCanal de envio: 'sms' ou 'whatsapp'.
codeLengthnumberNãoTamanho do código OTP. Valores permitidos: 4 ou 6. Padrão: 6.

2. Check OTP Code

CampoTipoObrigatórioDescrição
tostringSimNúmero de destino em formato internacional (E.164), ex: +971501234567.
codestringSimO código numérico de verificação inserido pelo usuário final.
# 1. Send OTP
curl -X POST https://api.smsala.com/v1/verify/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "channel": "sms",
    "codeLength": 6
  }'

# 2. Check OTP
curl -X POST https://api.smsala.com/v1/verify/check \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "code": "482910"
  }'
POST /v1/network/sim-swap

Network APIs

Acesse dados telemétricos das operadoras móveis em tempo real. Identifique fraudes financeiras verificando trocas recentes de chip (SIM Swap) antes de gerar transações Pix.

Parâmetros da Requisição

CampoTipoObrigatórioDescrição
tostringSimNúmero de celular para consulta em formato internacional (E.164).
maxAgeHoursnumberNãoJanela de tempo em horas para verificar alterações de SIM Swap. Padrão: 24.
curl -X POST https://api.smsala.com/v1/network/sim-swap \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "maxAgeHours": 24
  }'