Metadata do Grupo
Método#
/group-metadata#
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/group-metadata/{phone}
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN 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"
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| groupId | string | ID/Fone do grupo |
Opcionais#
| Atributos | Tipo | Descrição |
|---|
Request Params#
URL#
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/group-metadata/{phone}
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | ID/Fone do Grupo |
| description | string | Descrição do grupo |
| owner | string | Número do criador do grupo |
| subject | string | Nome do grupo |
| creation | timestamp | Timestamp da data de criação do grupo |
| invitationLink | url | Link de convite do grupo (retorna apenas para admin) |
| invitationLinkError | string | Mensagem de erro caso invitationLink seja nulo (forbidden, not-authorized, too many requests) |
| communityId | string | ID da comunidade |
| adminOnlyMessage | boolean | Indica se apenas Admin pode mandar mensagens |
| adminOnlySettings | boolean | Indica se apenas Admin pode mudar as configurações |
| requireAdminApproval | boolean | Indica se necessita aprovação de admin para entrar no grupo |
| isGroupAnnouncement | boolean | Indica se é um grupo de aviso |
| participants | array string | com dados dos participantes |
Array String (participants)
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Fone do participante |
| isAdmin | string | Indica se o participante é administrador do grupo |
| isSuperAdmin | string | Indica se é o criador do grupo |
Exemplo
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"