Skip to main content
GET
/
api
/
{session}
/
channels
Get list of known channels
curl --request GET \
  --url https://{host}/api/{session}/channels \
  --header 'apikey: <api-key>'
{
  "newsletters": [
    {
      "id": "123456789@newsletter",
      "name": "News Channel",
      "description": "Latest news and updates"
    },
    {
      "id": "987654321@newsletter",
      "name": "Technology Channel",
      "description": "Tech world news"
    }
  ]
}

​
Description

This endpoint returns a list of all channels that the session knows, including followed channels and other channels available on WhatsApp.

​
URL Parameters

​
session
string
required
WhatsApp unique authenticated session ID

​
Response

​
newsletters
array
Array containing the known channels
{
  "newsletters": [
    {
      "id": "123456789@newsletter",
      "name": "News Channel",
      "description": "Latest news and updates"
    },
    {
      "id": "987654321@newsletter",
      "name": "Technology Channel",
      "description": "Tech world news"
    }
  ]
}

​
Status Codes

  • 200 - List obtained successfully
  • 401 - Unauthorized
  • 500 - Internal server error

​
Usage Example

curl -X GET https://api.wappfy.com.br/api/my-session/channels

Authorizations

​
apikey
string
header
required

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

Query Parameters

​
role
enum<string>
Available options:
OWNER,
ADMIN,
SUBSCRIBER

Response

200 - application/json
​
id
string
required

Newsletter id

Example:

"123123123123@newsletter"

​
name
string
required

Channel name

Example:

"Channel Name"

​
invite
string
required

Invite link

Example:

"https://www.whatsapp.com/channel/111111111111111111111111"

​
role
enum<string>
required
Available options:
OWNER,
ADMIN,
SUBSCRIBER,
GUEST
​
verified
boolean
required
​
subscribersCount
number
required
​
preview
string

Preview for channel's picture

Example:

"https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10"

​
picture
string

Channel's picture

Example:

"https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10"

​
description
string
⌘I