Pular para o conteúdo principal

Metadata do Grupo (leve)

Método#

/light-group-metadata#

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/light-group-metadata/{phone}

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

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 momento obter esse link é custoso e ligeiramente demorado. Sabendo disso, disponibilizamos uma forma "leve" de obter o metadata do grupo.

Caso você queira utilizar este método e posteriormente necessite do link de convite do grupo, você pode obtê-lo na API de Obter link de convite do grupo.

Atenção

No dia 4 de novembro de 2021 o whatsapp alterou a formato da criação de novos grupos, antes: "phone": "5511999999999-1623281429" agora: "phone": "120363019502650977-group"


Atributos#

Obrigatórios#

AtributosTipoDescrição
groupIdstringID/Fone do grupo

Opcionais#

AtributosTipoDescrição

Request Params#

URL#

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/light-group-metadata/{phone}


Response#

200#

AtributosTipoDescrição
phonestringID/Fone do Grupo
descriptionstringDescrição do grupo
ownerstringNúmero do criador do grupo
subjectstringNome do grupo
creationtimestampTimestamp da data de criação do grupo
communityIdstringID da comunidade
adminOnlyMessagebooleanIndica se apenas Admin pode mandar mensagens
adminOnlySettingsbooleanIndica se apenas Admin pode mudar as configurações
requireAdminApprovalbooleanIndica se necessita aprovação de admin para entrar no grupo
isGroupAnnouncementbooleanIndica se é um grupo de aviso
participantsarray stringcom dados dos participantes

Array String (participants)

AtributosTipoDescrição
phonestringFone do participante
isAdminstringIndica se o participante é administrador do grupo
isSuperAdminstringIndica se é o criador do grupo

Exemplo

{
"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 o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"


Code#