Skip to main content
POST
Recupera informações completas de um grupo, incluindo detalhes, participantes, configurações e opcionalmente o link de convite e solicitações pendentes.

Informações Disponíveis

Informações básicas e identificação do grupo.Dados incluídos:
  • ID do grupo (JID)
  • Nome do grupo
  • Descrição
  • Foto de perfil (URL)
  • Criador do grupo
  • Data de criação
  • Timestamp da última atualização
Informações essenciais para identificação e gestão.
Informações completas sobre todos os membros do grupo.Para cada participante:
  • JID (identificador único)
  • Número de telefone
  • Nome
  • Se é administrador
  • Se é super administrador
  • Data de entrada no grupo
Permite gerenciar permissões e visualizar hierarquia.
Preferências e restrições configuradas no grupo.Configurações disponíveis:
  • announce: Apenas admins podem enviar mensagens
  • restrict: Apenas admins podem editar info do grupo
  • memberAddMode: Modo de aprovação para novos membros
  • ephemeralDuration: Duração das mensagens temporárias
  • isCommunity: Se faz parte de uma comunidade
Útil para entender permissões e comportamento do grupo.
Informações adicionais mediante solicitação.Link de convite (getInviteLink: true):
  • URL completa do link de convite
  • Código do convite
  • Permite compartilhar acesso ao grupo
Solicitações pendentes (getRequestsParticipants: true):
  • Lista de números aguardando aprovação
  • Útil para grupos com aprovação de entrada
Atualização forçada (force: true):
  • Ignora cache e busca dados atualizados
  • Use quando precisar de informações em tempo real

Authorization

string
required
Chave de autenticação da sua conexão, utilizada no header Authorization como Bearer Token.
Você encontra sua API Key no botão API da sua conexão no painel ZapClass.
A chave sempre começa com o prefixo zc_.
Exemplo: zc_6FrX2qjM4bHT9pR6cC0sD8wLkG3nE2tZfV5uN1aP

Body Parameters

string
required
Identificador único do grupo (JID).
Formato: número@g.us
Exemplo: 120363153742561022@g.us
Recuperar link de convite do grupo.
Requer permissão de administrador.
Padrão: false
Exemplo: true
boolean
Recuperar lista de solicitações pendentes.
Útil para grupos com aprovação de entrada.
Padrão: false
Exemplo: true
boolean
Forçar atualização ignorando cache.
Use para obter dados mais recentes.
Padrão: false
Exemplo: true
Nota: Para obter o link de convite, você precisa ser administrador do grupo.