Documentação de API
API CONNECT SMS: autenticação por chave Bearer. Crie e revogue as chaves no painel do cliente; a chave completa é exibida uma única vez.
| Endpoint | Método | Permissão | Finalidade |
|---|---|---|---|
/api/v1/balance | GET | sms:read | Consultar saldo interno |
/api/v1/message-status?id=123 | GET | sms:read | Consultar status registrado de mensagem da empresa |
/api/v1/sms | POST | sms:send | Solicitar envio, somente após homologação do gateway/worker |
Envio externo
O envio ainda depende de fornecedor e trabalhador homologados. Sem isso, a API retorna indisponibilidade e não debita créditos.
Use Content-Type: application/json, Authorization: Bearer SEU_TOKEN e Idempotency-Key de 16 a 128 caracteres. Nunca publique seu token em páginas ou repositórios.
Esta página documenta os endpoints existentes, mas não certifica entrega de SMS externo.