Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
group-metadata
/
{phone}
Metadata do grupo
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone} \
  --header 'Client-Token: <api-key>'
{
  "phone": "<string>",
  "description": "<string>",
  "owner": "<string>",
  "subject": "<string>",
  "creation": 123,
  "invitationLink": "<string>",
  "communityId": "<string>",
  "adminOnlyMessage": true,
  "adminOnlySettings": true,
  "requireAdminApproval": true,
  "isGroupAnnouncement": true,
  "participants": [
    {}
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método retorna o metadata do grupo com todas informações do grupo e de seus participantes.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Path

​
phone
string
obrigatório
ID/Phone do grupo

​
Response

​
200

​
phone
string
ID/Phone do grupo
​
description
string
Descrição do grupo
​
owner
string
Número do criador do grupo
​
subject
string
Nome do grupo
​
creation
number
Data de criação do grupo (timestamp)
​
invitationLink
string
Link de convite do grupo (apenas admin)
​
communityId
string
ID da comunidade
​
adminOnlyMessage
boolean
Apenas admin pode enviar mensagens
​
adminOnlySettings
boolean
Apenas admin pode alterar configurações
​
requireAdminApproval
boolean
Aprovação de admin necessária para entrar
​
isGroupAnnouncement
boolean
Indica se é um grupo de avisos
​
participants
array
Array com dados dos participantes
{
  "phone": "120363019502650977-group",
  "description": "Grupo Z-API",
  "owner": "5511999999999",
  "subject": "Meu grupo no Z-API",
  "creation": 1588721491000,
  "invitationLink": "https://chat.whatsapp.com/40Aasd6af1",
  "communityId": null,
  "adminOnlyMessage": false,
  "adminOnlySettings": false,
  "requireAdminApproval": false,
  "isGroupAnnouncement": false,
  "participants": [
    {
      "phone": "5511888888888",
      "isAdmin": false,
      "isSuperAdmin": false
    },
    {
      "phone": "5511777777777",
      "isAdmin": true,
      "isSuperAdmin": false,
      "short": "ZAPIs",
      "name": "ZAPIs Boys"
    }
  ],
  "subjectTime": 1617805323000,
  "subjectOwner": "554497050785"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.