Settings

Connect Instance

Connects the instance to WhatsApp. You must scan the QR code after this call.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/instance/connect

Authentication with the x-api-key and x-api-secret headers.

Parameters

NameTypeInRequiredDescription
phonetextbodyNoPhone number in international format (e.g. 5511999999999). If provided, a pairing code is generated. If omitted, a QR code is generated.

Request example

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/instance/connect" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"phone":"5511999999999"}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/instance/connect", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "phone": "5511999999999"
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/instance/connect",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"phone":"5511999999999"},
)
print(res.json())

Response example

JSON

{
  "connected": true,
  "instance": {
    "id": "raa287d88df6336",
    "status": "connected",
    "name": "minha-instancia"
  },
  "response": "Already connected",
  "status": {
    "connected": true,
    "loggedIn": true
  }
}

Values are illustrative; the fields follow the real response format.

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.