Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
search-newsletter
Encontrar canais
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/search-newsletter \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 123,
  "filters": {
    "countryCodes": [
      {}
    ]
  }
}
'
{
  "id": "<string>",
  "creationTime": 123,
  "state": "<string>",
  "name": "<string>",
  "description": "<string>",
  "subscribersCount": "<string>",
  "inviteLink": "<string>",
  "verification": "<string>",
  "picture": "<string>",
  "preview": "<string>",
  "viewMetadata": {
    "mute": "<string>",
    "role": "<string>"
  }
}

​
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

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Body

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

​
Request Body

{
  "limit": 50,
  "view": "TRENDING",
  "filters": {
    "countryCodes": ["BR", "AF", "CA"]
  },
  "searchText": "Z-API"
}

​
Response

​
200

Retorna um array de objetos de canais.
​
id
string
ID do canal
​
creationTime
number
Timestamp de criação do canal
​
state
string
Estado do canal (ACTIVE ou NON_EXISTING)
​
name
string
Nome do canal
​
description
string
Descrição do canal
​
subscribersCount
string
Número de inscritos do canal
​
inviteLink
string
Link de convite do canal
​
verification
string
Status de verificação (VERIFIED ou UNVERIFIED)
​
picture
string
URL da imagem do canal
​
preview
string
URL da imagem de preview do canal
​
viewMetadata
object
Informações de visualização do canal
[
  {
    "id": "999999999999999999@newsletter",
    "creationTime": 1695124988,
    "state": "ACTIVE",
    "name": "Nome do canal",
    "description": "Descrição",
    "subscribersCount": "150",
    "inviteLink": "https://whatsapp.com/channel/...",
    "verification": "VERIFIED",
    "picture": "https://...",
    "preview": "https://...",
    "viewMetadata": {
      "mute": "OFF",
      "role": "OWNER"
    }
  }
]
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”.