Skip to main content
GET
Get channel information

Description

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

URL Parameters

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

Response

string
Unique ID of the channel
string
Name of the channel
string
Description of the channel
number
Number of followers of the channel
string
URL of the channel image

Status Codes

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

Usage Example

Authorizations

apikey
string
header
required

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

Path Parameters

session
string
required

Session name (instanceName)

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