Pular para o conteúdo principal
GET
/
instances
/
{id}
/
group
/
info
Consultar grupo
curl --request GET \
  --url https://api.vzaps.com/instances/{id}/group/info \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "success": true,
  "data": {
    "jid": "120363021234567890@g.us",
    "owner_jid": "5511999999999@s.whatsapp.net",
    "owner_pn": "5511999999999",
    "name": "Equipe Vendas",
    "topic": "Pedidos e follow-up",
    "topic_deleted": false,
    "is_locked": false,
    "is_announce": false,
    "is_ephemeral": false,
    "disappearing_timer": 0,
    "group_created": "2025-11-20T14:30:00Z",
    "participant_count": 2,
    "total_participants": 2,
    "is_admin": true,
    "invite_url": "https://chat.whatsapp.com/AbCdEfGhIjKlMnOpQrStUv",
    "participants": [
      {
        "jid": "5511999999999@s.whatsapp.net",
        "phone_number": "5511999999999@s.whatsapp.net",
        "lid": "",
        "is_admin": true,
        "is_super_admin": true,
        "display_name": "Maria",
        "error": 0
      }
    ]
  }
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string
obrigatório

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Parâmetros de consulta

groupId
string
obrigatório

Resposta

200 - application/json

Dados do grupo

code
integer
obrigatório
success
boolean
obrigatório
data
object

Metadados de um grupo WhatsApp (subconjunto dos campos; outros podem aparecer).