Metadata do canal
Método#
/newsletter/metadata#
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/metadata/{newsletterId}
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Este método retorna o metadata do canal com todas as informações do canal e de sua visualização.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | ID do canal |
Request Params#
URL#
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/metadata/{newsletterId}
warning
O id do canal sempre deve conter o sufixo "@newsletter", pois esse é o padrão utilizado pelo próprio WhatsApp.
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | ID do canal |
| creationTime | timestamp | Timestamp da data de criação do grupo |
| state | string | Estado do canal (ACTIVE, NON_EXISTING) |
| name | string | Nome do canal |
| description | string | Descrição do canal |
| subscribersCount | string | Contagem do número de seguidores do canal |
| inviteLink | string | Link de convite do canal |
| verification | string | Indica se o canal é verificado ou não (VERIFIED, UNVERIFIED) |
| picture | string | Url da imagem do canal |
| preview | string | Url de preview da imagem do canal |
| viewMetadata | object | Objeto com informações de visualização |
Object (viewMetadata)
| Atributos | Tipo | Descrição |
|---|---|---|
| mute | string | Indica se o canal esta mutado ou não (ON, OFF) |
| role | string | Indica se é o proprietário ou seguidor do canal (OWNER, SUBSCRIBER) |
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"