Skip to main content
GET
Metadata do canal

Conceituação

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

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

Query Parameters

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

string
ID do canal
number
Timestamp de criação do canal
string
Estado do canal (ACTIVE ou NON_EXISTING)
string
Nome do canal
string
Descrição do canal
string
Número de inscritos do canal
Link de convite do canal
string
Status de verificação (VERIFIED ou UNVERIFIED)
string
URL da imagem do canal
string
URL da imagem de preview do canal
object
Informações de visualização do canal
array
Lista com até 9 seguidores do canal. Só é retornada quando o parâmetro mustGetSubscribers é enviado como true.
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. 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”.