Conectar instância ao WhatsApp
Instancia
Conectar instância ao WhatsApp
Inicia o processo de conexão de uma instância ao WhatsApp. Este endpoint:
- Requer o token de autenticação da instância
- Recebe o número de telefone associado à conta WhatsApp
- Gera um QR code caso não passe o campo
phone - Ou Gera código de pareamento se passar o o campo
phone - Atualiza o status da instância para “connecting”
O processo de conexão permanece pendente até que:
- O QR code seja escaneado no WhatsApp do celular, ou
- O código de pareamento seja usado no WhatsApp
- Timeout de 2 minutos para QRCode seja atingido ou 5 minutos para o código de pareamento
Use o endpoint /instance/status para monitorar o progresso da conexão.
Estados possíveis da instância:
disconnected: Desconectado do WhatsAppconnecting: Em processo de conexãoconnected: Conectado e autenticado
Exemplo de requisição:
{
"phone": "5511999999999"
}
POST
Conectar instância ao WhatsApp
Autorizações
Corpo
application/json
Número de telefone no formato internacional (ex: 5511999999999)
Pattern:
^\d{10,15}$Exemplo:
"5511999999999"
Resposta
Sucesso
Estado atual da conexão
Exemplo:
false
Estado do login
Exemplo:
false
ID do WhatsApp (quando logado)
Exemplo:
null
Detalhes completos da instância
Exemplo:
{
"id": "i91011ijkl",
"token": "abc123xyz",
"status": "connected",
"paircode": "1234-5678",
"qrcode": "data:image/png;base64,iVBORw0KGg...",
"name": "Instância Principal",
"profileName": "Loja ABC",
"profilePicUrl": "https://example.com/profile.jpg",
"isBusiness": true,
"plataform": "Android",
"systemName": "ZappFy",
"owner": "user@example.com",
"lastDisconnect": "2025-01-24T14:00:00Z",
"lastDisconnectReason": "Network error",
"adminField01": "custom_data",
"openai_apikey": "sk-...xyz",
"chatbot_enabled": true,
"chatbot_ignoreGroups": true,
"chatbot_stopConversation": "parar",
"chatbot_stopMinutes": 60,
"created": "2025-01-24T14:00:00Z",
"updated": "2025-01-24T14:30:00Z",
"delayMin": 2,
"delayMax": 4
}
