Pular para o conteúdo principal
POST
/
group
/
info
Obter informações detalhadas de um grupo
curl --request POST \
  --url https://api.zappfy.io/group/info \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "groupjid": "120363153742561022@g.us",
  "getInviteLink": true,
  "getRequestsParticipants": false,
  "force": false
}
'
{
  "JID": "120363153742561022@g.us",
  "Name": "ZappFy Community",
  "Participants": [
    {
      "JID": "5521987654321@s.whatsapp.net",
      "IsAdmin": true
    }
  ],
  "IsLocked": false,
  "IsAnnounce": false
}

Autorizações

​
token
string
header
obrigatório

Corpo

application/json
​
groupjid
string
obrigatório

Identificador único do grupo (JID)

Exemplo:

"120363153742561022@g.us"

​
getInviteLink
boolean
padrão:false

Recuperar link de convite do grupo

Exemplo:

true

​
getRequestsParticipants
boolean
padrão:false

Recuperar lista de solicitações pendentes de participação

Exemplo:

false

​
force
boolean
padrão:false

Forçar atualização, ignorando cache

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"

​
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

​
Topic
string

Descrição do grupo

​
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

​
GroupCreated
string<date-time>

Data de criação do grupo

​
ParticipantVersionID
string

Versão da lista de participantes

​
Participants
any[]

Lista de participantes do grupo

​
MemberAddMode
enum<string>

Modo de adição de novos membros

Opções disponíveis:
admin_add,
all_member_add
​
OwnerCanSendMessage
boolean

Verifica se é possível você enviar mensagens

​
OwnerIsAdmin
boolean

Verifica se você adminstrador do grupo

​
DefaultSubGroupId
string

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

​
invite_link
string

Link de convite para entrar no grupo

​
request_participants
string

Lista de solicitações de entrada, separados por vírgula