Skip to main content
A API Key é o cartão de acesso: cada escopo abre uma porta. Em produção, libere só o que sua integração precisa.

Em poucas palavras

  • Escopos sms:* cobrem envio, leitura e cancelamento.
  • SMS não usa instância, não há instanceIds no canal.
  • Guia geral: Chaves de API. Primeiro envio: Quick Start.

Como enviar a chave

Alternativa: x-api-key: sk_live_xxxxx.
Escopos vazios na criação = acesso ADMIN (tudo). Em produção, restrinja sempre.

Combinações prontas

Só enviar

sms:send

Enviar e consultar

sms:send, sms:read

Com agendamento

sms:send, sms:cancel

Fluxo completo

sms:send, sms:read, sms:cancel

Escopos disponíveis

Enviar SMS imediato ou agendado (POST /v1/sms/messages).
Listar enviados, consultar por id e SMS recebidos (MO).
Cancelar agendado (SCHEDULED), créditos devolvidos.

Erros comuns

Catálogo completo: Respostas de erro (accordion SMS).

Próximos passos