Encontrar canais
Método#
/search-newsletter#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/search-newsletter
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
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#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| limit | number | Limit de registros a serem listados |
| filters | object | Objeto com filtros a serem aplicados |
Object (filters)
| Atributos | Tipo | Descrição |
|---|---|---|
| countryCodes | array string | Array com codigo de países (https://www.iban.com/country-codes) |
Opcionais#
| Atributos | Tipo | Descrição |
|---|---|---|
| view | string | Filtro de visualização (RECOMMENDED, TRENDING, POPULAR, NEW) |
| searchText | string | Filtragem por texto |
Request Body#
URL#
Método
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/search-newsletter
Body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | ID do canal |
| name | string | Nome do canal |
| description | string | Descrição do canal |
| subscribersCount | string | Contagem do número de seguidores do canal |
| picture | string | Url da imagem do canal |
Exemplo
Atributo "cursor" no objeto de resposta
A api do Whatsapp fornece o atributo "limit" para realizar a busca dos canais, o que significa que existe paginação dos resultados. Porém, na resposta não existe a indicação do "cursor" dos registros. Sendo assim, por enquanto, o atributo "cursor" sempre será "null", até que o Whatsapp implemente essa funcionalidade.
405#
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"