Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
light-group-metadata
/
{phone}
Metadata do grupo (leve)
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/light-group-metadata/{phone} \
  --header 'Client-Token: <api-key>'

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 com exceção do link de convite do grupo.
A única diferença entre este método e o Metadata do Grupo é que nesse não é retornado o link de convite do grupo, pois em certos momentos obter esse link é custoso e ligeiramente demorado. Caso precise do link, utilize o método Obter link de convite do grupo.

​
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": "120363019502650977-group",
  "description": "Grupo Z-API",
  "owner": "5511999999999",
  "subject": "Meu grupo no Z-API",
  "creation": 1588721491000,
  "invitationLink": null,
  "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”.