Sign in
📢 Channels

Get the channel info

You can use either id (123@newsletter) OR invite code (https://www.whatsapp.com/channel/123)

get/api/{session}/channels/{id}

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/{session}/channels/{id}
  • Auth: API key in header X-Api-Key

Path parameters

sessionstring required

Session name

idstring required

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

Response

idstring required

Newsletter id

namestring required

Channel name

invitestring required

Invite link

previewstring

Preview for channel's picture

picturestring

Channel's picture

role'OWNER' | 'ADMIN' | 'SUBSCRIBER' | 'GUEST' required
descriptionstring
verifiedboolean required
subscribersCountnumber required

Example response

{
  "id": "123123123123@newsletter",
  "name": "Channel Name",
  "invite": "https://www.whatsapp.com/channel/111111111111111111111111",
  "preview": "https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10",
  "picture": "https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10"
}

Changes

No recorded changes to this operation across all 1 revision of this API.