Search Channels by Text

Search channels through text (name or description)

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

Pesquisar canais (por texto) (Search for channels (by text))

cURL

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": ""
}
'

Requisição

{
  "text": "tecnologia",
  "categories": ["tech", "news"],
  "page": {
    "limit": 10,
    "startCursor": ""
  }
}

Description

This endpoint allows you to search channels on WhatsApp using free text. The search can be filtered by categories and supports pagination to navigate through results.

URL Parameters

session · string · required

WhatsApp unique authenticated session ID

Request Body

text · string · required

Text to search in channels (name or description)

categories · array

Array of categories to filter the search (optional)

page · object

Pagination settings

Show Pagination properties

limit · number · default: "10"

Maximum number of results per page (default: 10)

startCursor · string

Cursor to start the search (used for pagination)

Response

channels · array

Array of found channels

nextCursor · string

Cursor for the next page of results

Requisição

{
  "text": "tecnologia",
  "categories": ["tech", "news"],
  "page": {
    "limit": 10,
    "startCursor": ""
  }
}

Status Codes

• 200 - Search performed successfully
• 400 - Invalid parameters or missing search text
• 401 - Unauthorized
• 500 - Internal server error

Usage Example

cURL

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

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

session · string · required

Session name (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

Show child attributes

channels · object[] · required

Show child attributes