Skip to main content
POST
/
api
/
{session}
/
channels
/
search
/
by-text
Pesquisar canais (por texto) (Search for channels (by text))
curl --request POST \
  --url https://{host}/api/{session}/channels/search/by-text \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "text": "Donald Trump",
  "categories": [],
  "limit": 50,
  "startCursor": ""
}
'
{
  "text": "tecnologia",
  "categories": ["tech", "news"],
  "page": {
    "limit": 10,
    "startCursor": ""
  }
}

​
Descrição

Este endpoint permite buscar canais no WhatsApp usando texto livre. A busca pode ser filtrada por categorias e suporta paginação para navegar pelos resultados.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp autenticada

​
Corpo da Requisição

​
text
string
required
Texto para buscar nos canais (nome ou descrição)
​
categories
array
Array de categorias para filtrar a busca (opcional)
​
page
object
Configurações de paginação

​
Resposta

​
channels
array
Array de canais encontrados
​
nextCursor
string
Cursor para a próxima página de resultados
{
  "text": "tecnologia",
  "categories": ["tech", "news"],
  "page": {
    "limit": 10,
    "startCursor": ""
  }
}

​
Códigos de Status

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

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/channels/search/by-text \
  -H "Content-Type: application/json" \
  -d '{
    "text": "tecnologia",
    "categories": ["tech"],
    "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
​
text
string
default:Donald Trump
required
​
categories
string[]
required
​
limit
number
default:50
required
​
startCursor
string
default:""
required

Response

200 - application/json
​
page
object
required
​
channels
object[]
required