Skip to main content
POST
Consultar detalhes e membros de um grupo

Autorizações

token
string
header
obrigatório

Corpo

application/json
groupjid
string
obrigatório

Identificador único do grupo (JID)

Exemplo:

"120363153742561022@g.us"

Opcional/avançado: solicita o convite, disponível somente para administrador com permissão confirmada.

Exemplo:

true

getRequestsParticipants
boolean
padrão:false

Opcional/avançado: solicita pedidos de entrada, disponíveis somente para administrador com permissão confirmada.

Exemplo:

false

force
boolean
padrão:false

Avançado: solicita atualização remota. O uso normal precisa apenas de groupjid.

Exemplo:

false

Resposta

Informações do grupo obtidas com sucesso

Representa um grupo/conversa coletiva

JID
string<jid>

Identificador único do grupo

Exemplo:

"jid8@g.us"

OwnerJID
string<jid>

JID do proprietário do grupo

Exemplo:

"1232@s.whatsapp.net"

OwnerPN
string<jid>

Número/LID do proprietário (quando disponível)

Name
string

Nome do grupo

Exemplo:

"Grupo de Suporte"

NameSetAt
string<date-time>

Data da última alteração do nome

NameSetBy
string<jid>

JID do usuário que definiu o nome

NameSetByPN
string<jid>

LID/PN de quem definiu o nome

Topic
string

Descrição do grupo

TopicID
string

ID interno da descrição

TopicSetAt
string<date-time>

Data da última alteração da descrição

TopicSetBy
string<jid>

JID de quem alterou a descrição

TopicSetByPN
string<jid>

LID/PN de quem alterou a descrição

TopicDeleted
boolean

Indica se a descrição foi apagada

IsLocked
boolean

Indica se apenas administradores podem editar informações do grupo

  • true = apenas admins podem editar
  • false = todos podem editar
Exemplo:

true

IsAnnounce
boolean

Indica se apenas administradores podem enviar mensagens

AnnounceVersionID
string

Versão da configuração de anúncios

IsEphemeral
boolean

Indica se as mensagens são temporárias

DisappearingTimer
integer

Tempo em segundos para desaparecimento de mensagens

Intervalo obrigatório: x >= 0
IsIncognito
boolean

Indica se o grupo é incognito

IsParent
boolean

Indica se é um grupo pai (comunidade)

IsJoinApprovalRequired
boolean

Indica se requer aprovação para novos membros

LinkedParentJID
string<jid>

JID da comunidade vinculada

IsDefaultSubGroup
boolean

Indica se é um subgrupo padrão da comunidade

DefaultMembershipApprovalMode
string

Modo padrão de aprovação de membros (quando comunidade)

GroupCreated
string<date-time>

Data de criação do grupo

CreatorCountryCode
string

Código do país do criador

ParticipantVersionID
string

Versão da lista de participantes

Participants
object[] | null

Lista de participantes. É null quando omitida por noParticipants e pode estar vazia quando participant_profiles estiver presente.

MemberAddMode
enum<string>

Modo de adição de novos membros

Opções disponíveis:
,
admin_add,
all_member_add
AddressingMode
enum<string>

Endereçamento preferido do grupo

Opções disponíveis:
,
pn,
lid
OwnerCanSendMessage
boolean

Verifica se é possível você enviar mensagens

OwnerIsAdmin
boolean

Indica privilégio de administrador confirmado. Pode estar ausente quando falso; dados parciais não concedem privilégio de administrador.

DefaultSubGroupId
string

Se o grupo atual for uma comunidade, nesse campo mostrará o ID do subgrupo de avisos

Link de convite, exposto somente para administrador com permissão confirmada. Pode estar ausente; não assuma que toda leitura consulta o WhatsApp.

request_participants
string

Pedidos conhecidos de entrada, separados por vírgula. Exposto somente para administrador quando solicitado.

image_url
string

URL da imagem completa já persistida; a API não consulta o WhatsApp durante a listagem

image_preview_url
string

URL do preview já persistido

picture_id
string

Identificador da imagem completa no WhatsApp

picture_preview_id
string

Identificador do preview no WhatsApp

picture_empty_at
string<date-time>

Última confirmação de que o grupo não possuía imagem

image_checked_at
string<date-time>

Última consulta da imagem completa

image_preview_checked_at
string<date-time>

Última consulta do preview

parent_community
object

Resumo da comunidade pai de um subgrupo

participant_profiles
object[]

Perfis adicionais dos participantes, quando disponíveis. Campos ausentes não devem ser inferidos.

ParticipantCount
integer

Quantidade conhecida de participantes. Pode diferir do tamanho da lista quando os dados estiverem parciais ou tiverem sido omitidos da resposta.

Intervalo obrigatório: x >= 0
request_participants_lid
string

LIDs dos pedidos conhecidos de entrada, separados por vírgula; somente para administrador quando solicitado.