# Pesquisar e descobrir canais

`POST /newsletter/search`

Pasta: **Newsletters e Canais**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Pesquisar e descobrir canais

Pesquisa canais públicos por texto ou navega pelo diretório do WhatsApp. Também permite obter recomendações e continuar uma página anterior.

## Endpoint

`POST {{baseUrl}}/newsletter/search`

## Autenticação

Envie o token da instância no header `token: {{token}}`.

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `query` | string | Não | Texto da pesquisa. Quando preenchido e sem modo especial, executa busca por palavra-chave. |
| `limit` | integer | Não | Quantidade de resultados solicitada. |
| `country_codes` | array<string> | Não | Códigos de país, como `BR`, para filtrar resultados. |
| `categories` | array<string> | Não | Categorias usadas como filtro. |
| `cursor_token` | string | Não | Cursor retornado pela página anterior. |
| `view` | string | Não | Visão do diretório; sem valor, o padrão é `RECOMMENDED`. |
| `mode` | string | Não | Modo: `search`, `recommended`, `directory` ou `browse`. |

## Exemplo de Requisição

```bash
curl --request POST '{{baseUrl}}/newsletter/search' \
  --header 'token: {{token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "query": "promo",
  "limit": 20,
  "country_codes": [
    "BR"
  ],
  "categories": [],
  "cursor_token": "",
  "view": "RECOMMENDED",
  "mode": "search"
}'
```

## Resposta de Sucesso

```json
{
  "success": true,
  "newsletters": [
    {
      "jid": "120363123456789012@newsletter",
      "name": "Canal de Promoções"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "cursor-da-proxima-pagina"
  }
}
```

## Erros comuns

- `401 Unauthorized`: o header `token` não foi enviado ou é inválido.
- `400 Bad Request`: o JSON está malformado ou contém um identificador inválido.
- `500 Internal Server Error`: a conexão com o WhatsApp falhou ou a operação foi recusada.

## Observações

Esta rota não exige modo mobile. `mode: recommended` busca recomendações; `directory`/`browse` abre o diretório. Sem `query`, a API também navega pelo diretório.

## Corpo (exemplo)

```json
{
  "query": "promo",
  "limit": 20,
  "country_codes": [
    "BR"
  ],
  "categories": [],
  "cursor_token": "",
  "view": "RECOMMENDED",
  "mode": "search"
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/newsletter/search" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "promo",
  "limit": 20,
  "country_codes": [
    "BR"
  ],
  "categories": [],
  "cursor_token": "",
  "view": "RECOMMENDED",
  "mode": "search"
}'
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=newsletters-e-canais/pesquisar-e-descobrir-canais)