Package Information
Released: 2 mo ago
Downloads: 0 weekly / 0 monthly
Latest Version: 0.1.1
Documentation
SMSGo Node para n8n
Especificação técnica e esqueleto de node community para o n8n, permitindo que usuários disparem SMS e consultem status dentro de workflows de automação.
Resumo
| Campo | Valor |
|---|---|
| Plataforma | n8n (https://n8n.io/) |
| Tipo | Community node (npm) — pode evoluir para Verified Node Partner |
| Autenticação | API key SMSGo (SMSGo-key) |
| Público | DevOps, integradores, empresas com automação self-hosted ou cloud |
| Prioridade | P1 |
Funcionalidades (MVP)
- Send SMS — envia SMS único.
- Send Bulk SMS — envia SMS em massa.
- Get Send Status — consulta status de um envio.
- Get Balance — consulta saldo.
Fluxo de autenticação
- Usuário gera a chave de API no painel SMSGo em Minha conta → API.
- No n8n, cria uma credencial do tipo SMSGo API e informa a chave.
- O node envia a chave no header
SMSGo-keyem todas as requisições.
GET https://api.smsgo.com.br/v1/account/balance
SMSGo-key: sg_live_xxxxxxxxxxxxxxxxxxxxxxxx
Endpoints SMSGo utilizados
| Operação | Método | Endpoint |
|---|---|---|
| Enviar SMS | POST |
/v1/sms/send/single |
| Enviar em massa | POST |
/v1/sms/send/multiple |
| Consultar envio | GET |
/v1/sms/:id/show |
| Saldo | GET |
/v1/account/balance |
Estrutura do esqueleto
skeleton/
├── package.json
├── tsconfig.json
├── credentials/
│ └── SMSGoApi.credentials.ts
└── nodes/
└── SMSGo/
├── SMSGo.node.ts
├── SMSGo.node.json
└── smsgo.svg
Próximos passos
- Implementar operações de webhook trigger para receber status de entrega.
- Adicionar templates de workflow prontos (OTP, carrinho abandonado, alertas).
- Publicar como
n8n-nodes-smsgono npm e solicitar certificação de Verified Node.