Instâncias WhatsApp
Logs ao vivo
Conectando…
Referência da API
Autenticação
Gerenciamento de instâncias → API_KEY global no .env
Envio de mensagens → apiKey retornado ao criar a instância
Criar instância
POST /instancias
Authorization: Bearer <API_KEY global>
{ "nome": "Meu número" }
→ { "id": "uuid", "nome": "Meu número", "apiKey": "chave-da-instancia" }
Enviar mensagem
POST /instancias/:id/mensagens
Authorization: Bearer <apiKey da instância>
{
"destinatario": "5511999990000",
"mensagem": "Olá!",
"origem": "meu-sistema"
}
→ { "id": "uuid-msg", "status": "pendente" }
Consultar mensagem
GET /instancias/:id/mensagens/:msgId
Authorization: Bearer <apiKey da instância>
Status da instância
GET /instancias/:id/status
Authorization: Bearer <apiKey da instância>
→ { "id": "...", "nome": "...", "conectado": true }
Listar instâncias
GET /instancias
Authorization: Bearer <API_KEY global>
→ { "instancias": [ { "id", "nome", "conectado" } ] }
Remover instância
DELETE /instancias/:id
Authorization: Bearer <API_KEY global>
Mensagens recebidas
GET /instancias/:id/mensagens-recebidas?limite=50
Authorization: Bearer <apiKey da instância>
→ { "mensagens": [ { "id", "remetente", "mensagem", "tipo", "webhook_status", "recebido_em" } ] }
Configurar Webhook
PUT /instancias/:id/webhook
Authorization: Bearer <apiKey da instância>
{ "url": "https://meu-sistema.com/webhook" }
Payload recebido no webhook:
{
"instancia_id": "uuid",
"mensagem_id": "uuid",
"remetente": "5511999990000@s.whatsapp.net",
"mensagem": "Texto da mensagem",
"tipo": "texto",
"recebido_em": "2026-05-19T20:00:00.000Z"
}