Skip to main content
GET
/
api
/
{session}
/
channels
/
{id}
Get channel information
curl --request GET \
  --url https://{host}/api/{session}/channels/{id} \
  --header 'apikey: <api-key>'
{
  "id": "123456789@newsletter",
  "name": "News Channel",
  "description": "Latest news and updates",
  "followersCount": 1523,
  "picture": "https://..."
}

​
Description

This endpoint returns detailed information of a specific channel through its ID.

​
URL Parameters

​
session
string
required
WhatsApp unique authenticated session ID
​
id
string
required
Unique ID of the channel to get information

​
Response

​
id
string
Unique ID of the channel
​
name
string
Name of the channel
​
description
string
Description of the channel
​
followersCount
number
Number of followers of the channel
​
picture
string
URL of the channel image
{
  "id": "123456789@newsletter",
  "name": "News Channel",
  "description": "Latest news and updates",
  "followersCount": 1523,
  "picture": "https://..."
}

​
Status Codes

  • 200 - Information obtained successfully
  • 400 - Invalid ID
  • 401 - Unauthorized
  • 404 - Channel not found
  • 500 - Internal server error

​
Usage Example

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

Authorizations

​
apikey
string
header
required

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

Path Parameters

​
session
string
required

Session name (instanceName)

​
id
any
required

WhatsApp Channel ID or invite code from invite link https://www.whatsapp.com/channel/11111

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