Initiates the connection process of an instance to WhatsApp. This endpoint:
phone field is not passedphone field is passedConnection process remains pending until:
Use the /instance/status endpoint to monitor the connection progress.
Possible instance statuses:
disconnected: Disconnected from WhatsAppconnecting: In connection processconnected: Connected and authenticatedExample request:
{
"phone": "5511999999999"
}
Phone number in international format (ex: 5511999999999)
"5511999999999"
Success
Current connection status
false
Login status
false
WhatsApp ID (when logged in)
null
Full instance details
{
"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": "WppFy",
"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
}