Listar todos os grupos com filtros e paginacao
curl --request POST \
--url https://api.wppfy.com/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
}
'import requests
url = "https://api.wppfy.com/group/list"
payload = {
"page": 1,
"pageSize": 50,
"limit": 123,
"offset": 0,
"search": "<string>",
"force": False,
"noParticipants": False
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: 1,
pageSize: 50,
limit: 123,
offset: 0,
search: '<string>',
force: false,
noParticipants: false
})
};
fetch('https://api.wppfy.com/group/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/group/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page' => 1,
'pageSize' => 50,
'limit' => 123,
'offset' => 0,
'search' => '<string>',
'force' => false,
'noParticipants' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/group/list"
payload := strings.NewReader("{\n \"page\": 1,\n \"pageSize\": 50,\n \"limit\": 123,\n \"offset\": 0,\n \"search\": \"<string>\",\n \"force\": false,\n \"noParticipants\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/group/list")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"page\": 1,\n \"pageSize\": 50,\n \"limit\": 123,\n \"offset\": 0,\n \"search\": \"<string>\",\n \"force\": false,\n \"noParticipants\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/group/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"page\": 1,\n \"pageSize\": 50,\n \"limit\": 123,\n \"offset\": 0,\n \"search\": \"<string>\",\n \"force\": false,\n \"noParticipants\": false\n}"
response = http.request(request)
puts response.read_body{
"groups": [
{
"JID": "jid8@g.us",
"OwnerJID": "1232@s.whatsapp.net",
"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>"
],
"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
}
}{
"error": "<string>"
}Grupos e Comunidades
Listar todos os grupos com filtros e paginacao
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.
POST
/
group
/
list
Listar todos os grupos com filtros e paginacao
curl --request POST \
--url https://api.wppfy.com/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
}
'import requests
url = "https://api.wppfy.com/group/list"
payload = {
"page": 1,
"pageSize": 50,
"limit": 123,
"offset": 0,
"search": "<string>",
"force": False,
"noParticipants": False
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: 1,
pageSize: 50,
limit: 123,
offset: 0,
search: '<string>',
force: false,
noParticipants: false
})
};
fetch('https://api.wppfy.com/group/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/group/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page' => 1,
'pageSize' => 50,
'limit' => 123,
'offset' => 0,
'search' => '<string>',
'force' => false,
'noParticipants' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/group/list"
payload := strings.NewReader("{\n \"page\": 1,\n \"pageSize\": 50,\n \"limit\": 123,\n \"offset\": 0,\n \"search\": \"<string>\",\n \"force\": false,\n \"noParticipants\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/group/list")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"page\": 1,\n \"pageSize\": 50,\n \"limit\": 123,\n \"offset\": 0,\n \"search\": \"<string>\",\n \"force\": false,\n \"noParticipants\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/group/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"page\": 1,\n \"pageSize\": 50,\n \"limit\": 123,\n \"offset\": 0,\n \"search\": \"<string>\",\n \"force\": false,\n \"noParticipants\": false\n}"
response = http.request(request)
puts response.read_body{
"groups": [
{
"JID": "jid8@g.us",
"OwnerJID": "1232@s.whatsapp.net",
"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>"
],
"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
}
}{
"error": "<string>"
}Autorizações
Corpo
application/json
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.
⌘I
