Encontrar canais

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.

Header

Obrigatórios

Atributos

filter

Request Body:

Exemplo:

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

Response

200

Retorna um array de objetos de canais.

viewMetadata

Exemplo:

[
  {
    "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"
    }
  }
]

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

Alguns exemplos para auxiliar a implementação:

Exemplo em PHP:

<?php
$curl = curl_init();
curl_setopt_array($curl, [
 CURLOPT_URL => "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/search-newsletter",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_ENCODING => "",
 CURLOPT_MAXREDIRS => 10,
 CURLOPT_TIMEOUT => 30,
 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => json_encode([
   'limit' => 123,
   'filters' => [
       'countryCodes' => [
               [
                               
               ]
       ]
   ]
 ]),
 CURLOPT_HTTPHEADER => [
   "Client-Token: <api-key>",
   "Content-Type: application/json"
 ],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
 echo "cURL Error #:" . $err;
} else {
 echo $response;
}

Exemplo em Python:

import requests
url = "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/search-newsletter"
payload = {
   "limit": 123,
   "filters": { "countryCodes": [{}] }
}
headers = {
   "Client-Token": "<api-key>",
   "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)

Exemplo em JavaScript:

const options = {
 method: 'POST',
 headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
 body: JSON.stringify({limit: 123, filters: {countryCodes: [{}]}})
};
fetch('https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/search-newsletter', options)
 .then(res => res.json())
 .then(res => console.log(res))
 .catch(err => console.error(err));