atendroZAP Documentação
DocsGrupos
Markdown
GET/group/list

Listar grupos sincronizados

Contrato implementado; homologação real de grupos pendente. force=true consulta WhatsApp; noparticipants=true omite Participants.

Autenticação

Header obrigatório: token. Use o token da instância.

Base URL: a API do servidor selecionado, como https://1.atendro.cloud. O domínio wpp.atendro.cloud hospeda a documentação e o console.

Parâmetros de consulta

CampoTipoPresençaDescrição
forcebooleanopcionalPadrão: false
noparticipantsbooleanopcionalPadrão: false

Headers adicionais

CampoTipoPresençaDescrição
X-Request-IdstringopcionalASCII visível sem espaços, 1–128 caracteres. Inválido/ausente é substituído por UUID. Ecoado na resposta. Comprimento máximo: 128

Corpo da requisição

Não há corpo de requisição definido para esta operação.

Respostas

Listar grupos sincronizados

CampoTipoPresençaDescrição
groupsarray<object>obrigatório—
groups[].JIDstringobrigatório—
groups[].Namestringobrigatório—
groups[].Topicstringopcional—
groups[].OwnerJIDstringopcional—
groups[].OwnerPNstringopcional—
groups[].IsLockedbooleanopcional—
groups[].IsAnnouncebooleanopcional—
groups[].AddressingModestringopcional—
groups[].ParticipantCountintegerobrigatório—
groups[].Participantsarray<object>opcional—
groups[].Participants[].JIDstringobrigatório—
groups[].Participants[].PhoneNumberstringopcional—
groups[].Participants[].LIDstringopcional—
groups[].Participants[].IsAdminbooleanobrigatório—
groups[].Participants[].IsSuperAdminbooleanobrigatório—
groups[].Participants[].DisplayNamestringobrigatório—
groups[].Participants[].ErrorintegerobrigatórioCódigo por participante; 0 indica ausência de erro registrado.
groups[].invite_linkstringobrigatórioVazio se não solicitado ou sem permissão de admin.
groups[].PictureIDstringopcional—
groups[].lastMessageAtintegeropcionalUnix em segundos. Formato: int64
groups[].syncedAtintegeropcionalUnix em segundos. Formato: int64
groups[].leftbooleanopcional—
groups[].GroupCreatedstringopcionalRFC 3339. Formato: date-time