Pular para o conteúdo principal

Metadata do Grupo por Convite

Método#

/group-invitation-metadata#

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/group-invitation-metadata?url=url-do-grupo

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

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"


Response#

200#

AtributosTipoDescrição
phonestringID/Fone do Grupo
ownerstringNúmero do criador do grupo
subjectstringNome do grupo
descriptionstringDescrição do grupo
creationtimestampTimestamp da data de criação do grupo
invitationLinkurlLink de convite do grupo
contactsCountnumberNúmero de contatos presente no grupo
participantsCountnumberNúmero de participantes no grupo
participantsarray stringcom dados dos participantes

Array String (participants)

AtributosTipoDescrição
phonestringNúmero do participante
isAdminstringIndica se o participante é administrador do grupo
isSuperAdminstringIndica se é o criador do grupo
subjectTimetimestampData de criação do grupo
subjectOwnerstringNúmero do criador do grupo

Exemplo

{
"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 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#