Buscar Canais por Visualização

Buscar canais através de tipo de visualização (recomendados, populares, etc.)

POST /api/{session}/channels/search/by-view

Pesquisar canais (por visualização) (Search for channels (by view))

cURL

curl --request POST \
  --url https://{host}/api/{session}/channels/search/by-view \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "view": "RECOMMENDED",
  "countries": [
    "US"
  ],
  "categories": [],
  "limit": 50,
  "startCursor": ""
}
'

Requisição

{
  "view": "recommended",
  "categories": ["tech", "news"],
  "countries": ["BR", "US"],
  "page": {
    "limit": 10,
    "startCursor": ""
  }
}

Descrição

Este endpoint permite buscar canais no WhatsApp usando diferentes tipos de visualização, como canais recomendados, mais populares, ou categorias específicas. Suporta filtros por categorias e países, além de paginação.

Parâmetros de URL

session · string · required

ID único da sessão WhatsApp autenticada

Corpo da Requisição

view · string · required

Tipo de visualização para a busca (ex: “recommended”, “popular”, “trending”)

categories · array

Array de categorias para filtrar a busca (opcional)

countries · array

Array de códigos de países para filtrar a busca (opcional)

page · object

Configurações de paginação

Show Propriedades de paginação

limit · number · default: "10"

Número máximo de resultados por página (padrão: 10)

startCursor · string

Cursor para iniciar a busca (usado para paginação)

Resposta

channels · array

Array de canais encontrados

nextCursor · string

Cursor para a próxima página de resultados

Requisição

{
  "view": "recommended",
  "categories": ["tech", "news"],
  "countries": ["BR", "US"],
  "page": {
    "limit": 10,
    "startCursor": ""
  }
}

Códigos de Status

• 200 - Busca realizada com sucesso
• 400 - Parâmetros inválidos ou tipo de visualização faltando
• 401 - Não autorizado
• 500 - Erro interno do servidor

Exemplo de Uso

cURL

curl -X POST https://api.wappfy.com.br/api/my-session/channels/search/by-view \
  -H "Content-Type: application/json" \
  -d '{
    "view": "recommended",
    "categories": ["tech"],
    "countries": ["BR"],
    "page": {
      "limit": 10
    }
  }'

Authorizations

apikey · string · header · required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

session · string · required

Nome da sessão (instanceName)

Body

application/json

view · string · default: RECOMMENDED · required

countries · string[] · required

categories · string[] · required

limit · number · default: 50 · required

startCursor · string · default: "" · required

Response

200 - application/json

page · object · required

Show child attributes

channels · object[] · required

Show child attributes