Skip to main content
GET
/
instance
/
status
Get instance status
curl --request GET \
  --url https://api.wppfy.com/instance/status \
  --header 'token: <api-key>'
{
  "instance": {
    "id": "r183e2ef9597845",
    "name": "my-instance",
    "status": "connected",
    "profileName": "My WhatsApp",
    "currentTime": "2024-01-25T12:00:00.000Z"
  },
  "status": {
    "connected": true,
    "loggedIn": true,
    "jid": {
      "user": "5511999999999",
      "agent": 0,
      "device": 0,
      "server": "s.whatsapp.net"
    }
  }
}

Authorizations

​
token
string
header
required

Response

Success

​
instance
object

Representa uma instância do WhatsApp

Example:
{
  "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
}
​
status
object