Obter todos os grupos
curl --request GET \
--url https://{host}/api/{session}/groups \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/{session}/groups"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/{session}/groups', 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://{host}/api/{session}/groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <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"
"net/http"
"io"
)
func main() {
url := "https://{host}/api/{session}/groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/api/{session}/groups")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/{session}/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"groups": [
{
"id": "120363XXXXX@g.us",
"subject": "Grupo 1",
"participants": [...],
"creation": 1234567890
},
{
"id": "120363YYYYY@g.us",
"subject": "Grupo 2",
"participants": [...],
"creation": 1234567891
}
]
}
Grupos
Listar Todos os Grupos
Listar todos os grupos da sessão WhatsApp
GET
/
api
/
{session}
/
groups
Obter todos os grupos
curl --request GET \
--url https://{host}/api/{session}/groups \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/{session}/groups"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/{session}/groups', 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://{host}/api/{session}/groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <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"
"net/http"
"io"
)
func main() {
url := "https://{host}/api/{session}/groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/api/{session}/groups")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/{session}/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"groups": [
{
"id": "120363XXXXX@g.us",
"subject": "Grupo 1",
"participants": [...],
"creation": 1234567890
},
{
"id": "120363YYYYY@g.us",
"subject": "Grupo 2",
"participants": [...],
"creation": 1234567891
}
]
}
Descrição
Este endpoint retorna uma lista de todos os grupos em que a sessão está participando.Parâmetros de URL
string
required
ID único da sessão WhatsApp
Resposta
array
Array contendo todos os grupos da sessão
{
"groups": [
{
"id": "120363XXXXX@g.us",
"subject": "Grupo 1",
"participants": [...],
"creation": 1234567890
},
{
"id": "120363YYYYY@g.us",
"subject": "Grupo 2",
"participants": [...],
"creation": 1234567891
}
]
}
Códigos de Status
200- Grupos listados com sucesso400- Parâmetros inválidos401- Não autorizado
Exemplo de Uso
curl -X GET https://api.wappfy.com.br/api/my-session/groups
const session = 'my-session';
const response = await fetch(`https://api.wappfy.com.br/api/${session}/groups`);
const data = await response.json();
console.log(data.groups);
import requests
session = 'my-session'
response = requests.get(f'https://api.wappfy.com.br/api/{session}/groups')
data = response.json()
print(data['groups'])
Authorizations
Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)
Query Parameters
Ordenar por campo
Available options:
id, subject Ordem de ordenação - descendente (Z => A, Novo primeiro) ou ascendente (A => Z, Antigo primeiro) (Sort order - descending (Z => A, New first) or ascending (A => Z, Old first))
Available options:
desc, asc Excluir campos
Available options:
, participants Response
200 - application/json
The response is of type object.
