Listar seguidores do canal
curl --request GET \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId} \
--header 'Client-Token: <api-key>'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}"
headers = {"Client-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}")
.header("Client-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"phoneNumber": "<string>",
"displayName": "<string>",
"username": "<string>",
"role": "<string>",
"followTime": 123,
"adminProfile": {
"id": "<string>",
"name": "<string>",
"pictureDirectPath": "<string>"
}
}Newsletter
Listar seguidores do canal
Retorna a lista completa de seguidores do canal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
newsletter
/
subscribers
/
{newsletterId}
Listar seguidores do canal
curl --request GET \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId} \
--header 'Client-Token: <api-key>'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}"
headers = {"Client-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}")
.header("Client-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"phoneNumber": "<string>",
"displayName": "<string>",
"username": "<string>",
"role": "<string>",
"followTime": 123,
"adminProfile": {
"id": "<string>",
"name": "<string>",
"pictureDirectPath": "<string>"
}
}Conceituação
Este método retorna a lista completa de seguidores do canal.Atributos
Header
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.
Path
string
obrigatório
ID do canal
Response
200
Retorna um array de objetos de seguidores.string
ID do seguidor (pode ser um número de telefone ou um
@lid)string
Número de telefone do seguidor, quando disponível
string
Nome de exibição do seguidor, quando disponível
string
Nome de usuário do seguidor, quando disponível
string
Papel do seguidor no canal (OWNER, ADMIN ou SUBSCRIBER)
number
Timestamp de quando o usuário começou a seguir o canal, quando disponível
object
[
{
"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
}
]
O ID do canal sempre deve conter o sufixo @newsletter, pois esse é o padrão utilizado pelo próprio WhatsApp.
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.