Skip to main content
POST
/
instance
/
connect
Connect instance to WhatsApp
curl --request POST \
  --url https://api.wppfy.com/instance/connect \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "phone": "5511999999999"
}
'
{
  "connected": false,
  "loggedIn": false,
  "jid": null,
  "instance": {
    "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
  }
}

Authorizations

token
string
header
required

Body

application/json
phone
string
required

Phone number in international format (ex: 5511999999999)

Example:

"5511999999999"

Response

Success

connected
boolean

Current connection status

Example:

false

loggedIn
boolean

Login status

Example:

false

jid
object

WhatsApp ID (when logged in)

Example:

null

instance
object

Full instance details

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
}