Listar canais

Este método retorna o metadata dos canais que você é dono e dos canais que você segue.

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

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órios

Token da sua instância.

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.

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)

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"
   }
 }
]

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

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",
 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"
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', options)
 .then(res => res.json())
 .then(res => console.log(res))
 .catch(err => console.error(err));

Header

Obrigatórios

Response

Comentários

Header

Obrigatórios

Response

Artigos relacionados