Skip to main content
GET
Listar seguidores do canal

Conceituação

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

Atributos

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
Informações do perfil de admin do seguidor, quando ele for admin do canal
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.

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