Settings

Instance Info & Status

Returns full instance data: name, connected phone number, profile photo and current connection status (disconnected, connecting, connected).

GEThttps://api.zapzapapi.com/api/v1/{instanceId}/instance/status

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

Parameters

This endpoint takes no parameters.

Request example

curl

curl -X GET "https://api.zapzapapi.com/api/v1/{instanceId}/instance/status" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/instance/status", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
  },
});
console.log(await res.json());

Python

import requests

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

Response example

JSON

{
  "instance": {
    "status": "connected",
    "name": "minha-instancia",
    "profileName": "Meu Perfil",
    "owner": "5511999999999",
    "msg_delay_min": 1,
    "msg_delay_max": 3
  }
}

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

Other endpoints in this category

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.

Create free account View the documentation