API/Instâncias
Instâncias
Gerencie suas conexões WhatsApp com a API de instâncias
Visão geral
Uma instância representa uma conexão com um número de WhatsApp. Cada instância:
- Possui uma API Key única para autenticação
- Mantém sua própria sessão (login persistente)
- Pode ser conectada/desconectada independentemente
- Tem seus próprios webhooks configurados
Endpoints
POST
/instance/createCriar nova instânciaGET
/instance/listListar todas as instânciasGET
/instance/:name/statusStatus de uma instânciaPOST
/instance/:name/connectConectar (gera QR Code)POST
/instance/:name/restartReiniciar instânciaPOST
/instance/:name/logoutDesconectar instânciaDELETE
/instance/:nameDeletar instânciaModelo de dados
Instance Object
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "minha-instancia",
"api_key": "550e8400-e29b-...-ef1234567890",
"status": "connected",
"phone_number": "5511999999999",
"profile_name": "Minha Empresa",
"profile_pic": "https://pps.whatsapp.net/...",
"qr_code": null,
"device_jid": "5511999999999:123@s.whatsapp.net",
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-01-15T10:35:00.000Z"
}| Campo | Tipo | Descrição |
|---|---|---|
id | UUID | Identificador único |
name | string | Nome da instância (único) |
api_key | string | Chave de API para autenticação |
status | string | Status da conexão |
phone_number | string? | Número conectado |
profile_name | string? | Nome do perfil |
qr_code | string? | QR Code para conexão |
Status da instância
disconnectedInstância não está conectada ao WhatsApp
connectingTentando estabelecer conexão
qrcodeAguardando leitura do QR Code
connectedConectado e pronto para enviar/receber mensagens
errorErro na conexão