Metadados do grupo
curl --request GET \
--url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone} \
--header 'Client-Token: <api-key>'import requests
url = "https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}"
headers = {"Client-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};
fetch('https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}', 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.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Client-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"
"net/http"
"io"
)
func main() {
url := "https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-Token", "<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://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}")
.header("Client-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"phone": "120363123456789-group",
"owner": "5511999999999",
"subject": "Time EZ API",
"description": "Grupo operacional",
"creation": 1736200000,
"invitationLink": "https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA",
"contactsCount": 3,
"participantsCount": 3,
"participants": [
{
"phone": "5511999999999",
"isAdmin": true,
"isSuperAdmin": true
},
{
"phone": "5511888888888",
"isAdmin": false,
"isSuperAdmin": false
}
],
"adminOnlyMessage": false,
"adminOnlySettings": false,
"requireAdminApproval": false,
"isGroupAnnouncement": false,
"subjectTime": 1736200000,
"subjectOwner": "5511999999999",
"communityId": null
}{
"error": "Unauthorized",
"message": "Invalid instanceToken"
}{
"error": "Instance not found"
}{
"error": "Worker command timeout"
}{
"error": "Unable to process request"
}Grupos
Metadados do grupo
Retorna nome, descrição, participantes e outras informações do grupo.
GET
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
group-metadata
/
{groupPhone}
Metadados do grupo
curl --request GET \
--url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone} \
--header 'Client-Token: <api-key>'import requests
url = "https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}"
headers = {"Client-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};
fetch('https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}', 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.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Client-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"
"net/http"
"io"
)
func main() {
url := "https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-Token", "<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://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}")
.header("Client-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-metadata/{groupPhone}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"phone": "120363123456789-group",
"owner": "5511999999999",
"subject": "Time EZ API",
"description": "Grupo operacional",
"creation": 1736200000,
"invitationLink": "https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA",
"contactsCount": 3,
"participantsCount": 3,
"participants": [
{
"phone": "5511999999999",
"isAdmin": true,
"isSuperAdmin": true
},
{
"phone": "5511888888888",
"isAdmin": false,
"isSuperAdmin": false
}
],
"adminOnlyMessage": false,
"adminOnlySettings": false,
"requireAdminApproval": false,
"isGroupAnnouncement": false,
"subjectTime": 1736200000,
"subjectOwner": "5511999999999",
"communityId": null
}{
"error": "Unauthorized",
"message": "Invalid instanceToken"
}{
"error": "Instance not found"
}{
"error": "Worker command timeout"
}{
"error": "Unable to process request"
}Retorna nome, descrição, participantes e outras informações do grupo.
Aliases consolidados da collection:
Metadata do grupo.Authorizations
Path Parameters
Identificador único da instância.
Example:
"abc1234567890"
Token privado da instância retornado na criação.
Example:
"tok_a1b2c3d4e5f6"
Identificador do grupo. Pode ser enviado como 120363...-group ou no formato JID.
Example:
"120363123456789-group"
Response
Resposta de sucesso.
Example:
"120363123456789-group"
Example:
"5511999999999"
Example:
"Time EZ API"
Example:
"Grupo operacional"
Example:
1736200000
Example:
"https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA"
Example:
3
Example:
3
Show child attributes
Show child attributes
Example:
[
{
"phone": "5511999999999",
"isAdmin": true,
"isSuperAdmin": true
},
{
"phone": "5511888888888",
"isAdmin": false,
"isSuperAdmin": false
}
]
Example:
false
Example:
false
Example:
false
Example:
false
Example:
1736200000
Example:
"5511999999999"

