Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
group-invitation-metadata
Metadata do grupo por convite
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/group-invitation-metadata \
  --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 através do link de convite.

​
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.

​
Query Parameters

​
url
string
obrigatório
Link de convite do grupo. Ex: https://chat.whatsapp.com/KNmcL17DqVA0sqkQ5LLA5

​
Response

​
200

{
  "phone": "120363019502650977-group",
  "owner": "5511888888888",
  "subject": "Meu grupo no Z-API",
  "description": "descrição do grupo",
  "creation": 1588721491000,
  "invitationLink": "https://chat.whatsapp.com/KNmcL17DqVA0sqkQ5LLA5",
  "contactsCount": 1,
  "participantsCount": 1,
  "participants": [
    {
      "phone": "5511888888888",
      "isAdmin": false,
      "isSuperAdmin": true
    },
    {
      "phone": "5511777777777",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ],
  "subjectTime": 1617805323000,
  "subjectOwner": "5511888888888"
}

​
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”.