Skip to main content
POST
Encontrar canais

Conceituação

Este método retorna uma lista com dados de canais, de acordo com a busca realizada através de filtros passados no body da requisiçã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.

Body

number
obrigatório
Limite de registros
object
obrigatório
Filtros da busca
string
Tipo de visualização (RECOMMENDED, TRENDING, POPULAR ou NEW)
string
Texto de busca

Request Body


Response

200

Retorna um array de objetos de canais.
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
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”.