curl --request POST \
--url https://api.zappfy.io/group/list \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"page": 1,
"pageSize": 50,
"limit": 123,
"offset": 0,
"search": "<string>",
"force": false,
"noParticipants": false
}
'{
"groups": [
{
"JID": "[email protected]",
"OwnerJID": "[email protected]",
"Name": "Grupo de Suporte",
"NameSetAt": "2023-11-07T05:31:56Z",
"NameSetBy": "<string>",
"Topic": "<string>",
"IsLocked": true,
"IsAnnounce": true,
"AnnounceVersionID": "<string>",
"IsEphemeral": true,
"DisappearingTimer": 1,
"IsIncognito": true,
"IsParent": true,
"IsJoinApprovalRequired": true,
"LinkedParentJID": "<string>",
"IsDefaultSubGroup": true,
"GroupCreated": "2023-11-07T05:31:56Z",
"ParticipantVersionID": "<string>",
"Participants": [
"<unknown>"
],
"MemberAddMode": "admin_add",
"OwnerCanSendMessage": true,
"OwnerIsAdmin": true,
"DefaultSubGroupId": "<string>",
"invite_link": "<string>",
"request_participants": "<string>"
}
],
"pagination": {
"totalRecords": 123,
"pageSize": 123,
"currentPage": 123,
"totalPages": 123,
"hasNextPage": true,
"hasPreviousPage": true
}
}Retorna uma lista com todos os grupos disponiveis para a instancia atual do WhatsApp, com opcoes de filtros e paginacao via corpo (POST). A rota GET continua para quem prefere a listagem direta sem paginacao.
curl --request POST \
--url https://api.zappfy.io/group/list \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"page": 1,
"pageSize": 50,
"limit": 123,
"offset": 0,
"search": "<string>",
"force": false,
"noParticipants": false
}
'{
"groups": [
{
"JID": "[email protected]",
"OwnerJID": "[email protected]",
"Name": "Grupo de Suporte",
"NameSetAt": "2023-11-07T05:31:56Z",
"NameSetBy": "<string>",
"Topic": "<string>",
"IsLocked": true,
"IsAnnounce": true,
"AnnounceVersionID": "<string>",
"IsEphemeral": true,
"DisappearingTimer": 1,
"IsIncognito": true,
"IsParent": true,
"IsJoinApprovalRequired": true,
"LinkedParentJID": "<string>",
"IsDefaultSubGroup": true,
"GroupCreated": "2023-11-07T05:31:56Z",
"ParticipantVersionID": "<string>",
"Participants": [
"<unknown>"
],
"MemberAddMode": "admin_add",
"OwnerCanSendMessage": true,
"OwnerIsAdmin": true,
"DefaultSubGroupId": "<string>",
"invite_link": "<string>",
"request_participants": "<string>"
}
],
"pagination": {
"totalRecords": 123,
"pageSize": 123,
"currentPage": 123,
"totalPages": 123,
"hasNextPage": true,
"hasPreviousPage": true
}
}Numero da pagina para paginacao (padrao 1)
Quantidade de resultados por pagina (padrao 50, maximo 1000)
Alias opcional para pageSize
Deslocamento base zero; se informado recalcula a pagina
Texto para filtrar grupos por nome/JID
Se definido como true, forca a atualizacao do cache de grupos.
Util para garantir que as informacoes mais recentes sejam recuperadas.
Se definido como true, retorna a lista de grupos sem incluir os participantes.
Util para otimizar a resposta quando nao ha necessidade dos dados dos participantes.
Lista de grupos recuperada com sucesso
Lista detalhada de grupos
Mostrar atributos filhos
Identificador único do grupo
JID do proprietário do grupo
Nome do grupo
"Grupo de Suporte"
Data da última alteração do nome
JID do usuário que definiu o nome
Descrição do grupo
Indica se apenas administradores podem editar informações do grupo
true
Indica se apenas administradores podem enviar mensagens
Versão da configuração de anúncios
Indica se as mensagens são temporárias
Tempo em segundos para desaparecimento de mensagens
x >= 0Indica se o grupo é incognito
Indica se é um grupo pai (comunidade)
Indica se requer aprovação para novos membros
JID da comunidade vinculada
Indica se é um subgrupo padrão da comunidade
Data de criação do grupo
Versão da lista de participantes
Lista de participantes do grupo
Modo de adição de novos membros
admin_add, all_member_add Verifica se é possível você enviar mensagens
Verifica se você adminstrador do grupo
Se o grupo atual for uma comunidade, nesse campo mostrará o ID do subgrupo de avisos
Link de convite para entrar no grupo
Lista de solicitações de entrada, separados por vírgula
Mostrar atributos filhos
Total de grupos encontrados
Itens por pagina
Pagina atual
Numero total de paginas
Indica se existe uma proxima pagina
Indica se existe pagina anterior