curl -X GET "https://api.oxenty.api.br/api/groups/metadata?sessionId=550e8400-e29b-41d4-a716-446655440000&groupJid=120363123456789012@g.us" \
-H "X-API-Key: YOUR_API_KEY"
const metadata = await client.groups.getMetadata(sessionId, {
groupJid: '120363123456789012@g.us',
});
console.log(`Grupo: ${metadata.subject}`);
console.log(`Participantes: ${metadata.participants.length}`);
metadata = client.groups.get_metadata(
session_id,
group_jid='120363123456789012@g.us'
)
print(f"Grupo: {metadata['subject']}")
print(f"Participantes: {len(metadata['participants'])}")
{
"success": true,
"id": "120363123456789012@g.us",
"subject": "Equipe de Vendas",
"description": "Grupo para discussão de estratégias de vendas",
"owner": "5511777777777@s.whatsapp.net",
"creation": 1705315200,
"participants": [
{
"id": "5511777777777@s.whatsapp.net",
"admin": "superadmin"
},
{
"id": "5511999999999@s.whatsapp.net",
"admin": "admin"
},
{
"id": "5511888888888@s.whatsapp.net",
"admin": null
}
],
"restrict": false,
"announce": false
}
Grupos
Metadados do Grupo
Obtém informações detalhadas de um grupo
GET
/
api
/
groups
/
metadata
curl -X GET "https://api.oxenty.api.br/api/groups/metadata?sessionId=550e8400-e29b-41d4-a716-446655440000&groupJid=120363123456789012@g.us" \
-H "X-API-Key: YOUR_API_KEY"
const metadata = await client.groups.getMetadata(sessionId, {
groupJid: '120363123456789012@g.us',
});
console.log(`Grupo: ${metadata.subject}`);
console.log(`Participantes: ${metadata.participants.length}`);
metadata = client.groups.get_metadata(
session_id,
group_jid='120363123456789012@g.us'
)
print(f"Grupo: {metadata['subject']}")
print(f"Participantes: {len(metadata['participants'])}")
{
"success": true,
"id": "120363123456789012@g.us",
"subject": "Equipe de Vendas",
"description": "Grupo para discussão de estratégias de vendas",
"owner": "5511777777777@s.whatsapp.net",
"creation": 1705315200,
"participants": [
{
"id": "5511777777777@s.whatsapp.net",
"admin": "superadmin"
},
{
"id": "5511999999999@s.whatsapp.net",
"admin": "admin"
},
{
"id": "5511888888888@s.whatsapp.net",
"admin": null
}
],
"restrict": false,
"announce": false
}
Retorna metadados completos de um grupo, incluindo participantes e configurações.
Query Parameters
string
required
ID da sessão.
string
required
JID do grupo.
Resposta
boolean
Se a operação foi bem-sucedida.
string
JID do grupo.
string
Nome do grupo.
string
Descrição do grupo.
string
JID do criador.
number
Timestamp de criação.
array
boolean
Se apenas admins podem alterar informações do grupo.
boolean
Se apenas admins podem enviar mensagens.
curl -X GET "https://api.oxenty.api.br/api/groups/metadata?sessionId=550e8400-e29b-41d4-a716-446655440000&groupJid=120363123456789012@g.us" \
-H "X-API-Key: YOUR_API_KEY"
const metadata = await client.groups.getMetadata(sessionId, {
groupJid: '120363123456789012@g.us',
});
console.log(`Grupo: ${metadata.subject}`);
console.log(`Participantes: ${metadata.participants.length}`);
metadata = client.groups.get_metadata(
session_id,
group_jid='120363123456789012@g.us'
)
print(f"Grupo: {metadata['subject']}")
print(f"Participantes: {len(metadata['participants'])}")
{
"success": true,
"id": "120363123456789012@g.us",
"subject": "Equipe de Vendas",
"description": "Grupo para discussão de estratégias de vendas",
"owner": "5511777777777@s.whatsapp.net",
"creation": 1705315200,
"participants": [
{
"id": "5511777777777@s.whatsapp.net",
"admin": "superadmin"
},
{
"id": "5511999999999@s.whatsapp.net",
"admin": "admin"
},
{
"id": "5511888888888@s.whatsapp.net",
"admin": null
}
],
"restrict": false,
"announce": false
}