Metadata do canal

Este método retorna o metadata do canal com todas as informações do canal e de sua visualização.

TIPO	URL
GET	https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/metadata/ID_CANAL

Key	Value
Client-Token	TOKEN DE SEGURANÇA DA CONTA
Content-type	application/json

Obrigatórios

Atributos

Tipo

Descrição

instanceId

(SUA_INSTANCIA)

string

obrigatório

ID da sua instância.

token

(SEU_TOKEN)

string

obrigatório

Token da sua instância.

Path

Atributos

Tipo

Descrição

newsletterId (ID_CANAL)

string

obrigatório

ID do canal.

Query Params

Atributos	Tipo	Descrição
mustGetSubscribers	boolean	Quando enviado como `true`, inclui na resposta o campo `subscribers` com a lista de seguidores do canal. O valor padrão é `false`.

Response:

200

Atributos	Tipo	Descrição
id	string	ID do canal.
creationTime	number	Timestamp de criação do canal.
state	string	Estado do canal (ACTIVE ou NON_EXISTING).
name	string	Nome do canal.
description	string	Descrição do canal.
subscribersCount	string	Número de inscritos no canal.
inviteLink	string	Link de convite do canal.
verification	string	Status de verificação (VERIFIED ou UNVERIFIED).
picture	string	URL da imagem do canal.
preview	string	URL da imagem de preview do canal.
viewMetadata	viewMetadata	Informações de visualização do canal.
subscribers	subscribers	Lista com até 9 seguidores do canal. Só é retornada quando o parâmetro `mustGetSubscribers` é enviado como `true`.

viewMetadata

Atributos	Tipo	Descrição
mute	string	Status de mute do canal (ON ou OFF)
role	string	Papel do usuário no canal (OWNER ou SUBSCRIBER)

subscribers

Atributos	Tipo	Descrição
id	string	ID do seguidor (pode ser um número de telefone ou um `@lid`)
phoneNumber	string	Número de telefone do seguidor, quando disponível
displayName	string	Nome de exibição do seguidor, quando disponível
username	string	Nome de usuário do seguidor, quando disponível
role	string	Papel do seguidor no canal (OWNER, ADMIN ou SUBSCRIBER)
followTime	number	Timestamp de quando o usuário começou a seguir o canal, quando disponível
adminProfile	adminProfile	Informações do perfil de admin do seguidor, quando ele for admin do canal

adminProfile

Atributos	Tipo	Descrição
id	string	ID do admin.
name	string	Nome do admin.
pictureDirectPath	string	Caminho da imagem de perfil do admin, quando disponível.

Exemplo:

{
  "id": "999999999999999999@newsletter",
  "creationTime": 1695124988,
  "state": "ACTIVE",
  "name": "Nome do canal",
  "description": "Descrição",
  "subscribersCount": "150",
  "inviteLink": "https://whatsapp.com/channel/...",
  "verification": "VERIFIED",
  "picture": "https://...",
  "preview": "https://...",
  "viewMetadata": {
    "mute": "OFF",
    "role": "OWNER"
  },
  "subscribers": [
    {
      "id": "199690293383294@lid",
      "phoneNumber": null,
      "displayName": null,
      "username": null,
      "role": "SUBSCRIBER",
      "followTime": null,
      "adminProfile": null
    }
  ]
}

IMPORTANTE: O ID do canal sempre deve conter o sufixo @newsletter, pois esse é o padrão utilizado pelo próprio WhatsApp.

IMPORTANTE: O WhatsApp só retorna os seguidores que estiverem na lista de contatos de quem realizou a requisição, e é necessário que quem realiza a requisição seja admin do canal. Além disso, essa listagem retorna no máximo 9 seguidores, o mesmo limite exibido na tela de informações do canal no WhatsApp Web. Para obter a listagem completa de seguidores, utilize o endpoint Listar seguidores do canal.

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

Alguns exemplos para auxiliar a implementação:

Exemplo em PHP:

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/metadata/ID_CANAL",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Exemplo em Python:

import requests

url = "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/metadata/ID_CANAL"

headers = {"Client-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

Exemplo em JavaScript:

const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};

fetch('https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/metadata/ID_CANAL', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Header

Obrigatórios

Path

Query Params

Response:

Comentários

Header

Obrigatórios

Path

Query Params

Response:

Artigos relacionados