Listar seguidores do canal

Este método retorna a lista completa de seguidores do canal.

TIPO	URL
GET	https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/subscribers/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órios

Token da sua instância.

Path

Atributos

Tipo

Descrição

newsletterId (ID_CANAL)

string

obrigatório

ID do canal.

Response:

200

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	string	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": "199690293383294@lid",
   "phoneNumber": null,
   "displayName": null,
   "username": null,
   "role": "SUBSCRIBER",
   "followTime": null,
   "adminProfile": null
 },
 {
   "id": "277454937673921@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. Essa listagem não possui paginação, retornando todos os seguidores disponíveis em uma única resposta.

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

Header

Obrigatórios

Path

Response:

Comentários