feat: `Channel` #2620

alechkos · 2023-11-02T17:15:39Z

Client.createChannel that takes 2 parameters:
- title (required)
- an object options (optional) with properties:
  - description for a channel description
  - picture for a channel profile picture which will be set upon a channel creation
Client.subscribeToChannel to subscribe to channel that takes a channel ID
Client.unsubscribeFromChannel to unsubscribe from channel. The method takes 2 parameters:
- channelId (required)
- an object options (optional) with property deleteLocalModels. If true, after an unsubscription, it will completely remove a channel from the channel collection making it seem like the current user have never interacted with it. Otherwise it will only remove a channel from the list of channels the current user is subscribed to and will set the membership type for that channel to GUEST
Client.searchChannels to search channels, the method takes 5 optional parameters:
- searchText, the text by which you want to find the channel (empty string by default)
- countryCodes, an array of country codes in ISO 3166-1 alpha-2 standart to search for channels created in these countries, your local region is used as a value by default
- view for specifing the category of channels to get, valid values are:
  - RECOMMENDED (default value)
  - MOST_ACTIVE
  - POPULAR
  - NEW
  - FEATURED
- limit for specifing the limit of found channels to be appear in the returnig results (default value is 50)
- an optional object sortOptions to sort the returning results by with these properties:
  - field for specifing the field to sort by, valid values are:
    - SUBSCRIBERS (default value)
    - CREATION_TIME
  - order, valid values are:
    - DESCENDING (default value)
    - ASCENDING
Updated Client.getChatById to retrieve a Channel instance by its ID
Client.getChannelByInviteCode to retrieve a Channel instance by its invite code (that comes after https://whatsapp.com/channel/), e.g.: 0029Va4K0PZ5a245NkngBA2M (an invite code of a WhatsApp channel)
Client.getChannels that returns all your cached Channel objects as an array
Client.sendChannelAdminInvite and Channel.sendChannelAdminInvite to send a channel admin invitation to a user, allowing them to become an admin of the channel, you can also provide a text comment that will be sent along within invitation by providing a string in a comment property of an optional options object
Client.acceptChannelAdminInvite and Channel.acceptChannelAdminInvite to accept a channel admin invitation and promote the current user to a channel admin
Client.revokeChannelAdminInvite and Channel.revokeChannelAdminInvite to revoke a channel admin invitation previously sent to a user by a channel owner
Client.demoteChannelAdmin and Channel.demoteChannelAdmin to demote a channel admin to a regular subscriber (can be used also for self-demotion)
Channel.sendMessage and updated Client.sendMessage to send a message to a channel (currently supported message types to send are: text, image, sticker, gif, video and poll)
Channel.fetchMessages that works similarly to Chat.fetchMessages
Channel.getSubscribers to get subscribers of the channel (only those who are in your contact list), you can pass an optional limit parameter to specify the limit of subscribers to retrieve (if not specified, the limit value will be set to the maximum provided by WhatsApp)
Channel.setSubject that updates the channel subject (name)
Channel.setDescription that updates the channel description
Channel.setProfilePicture that updates the channel propfile picture
Channel.setReactionSetting that updates available reactions to use in the channel, valid values to pass:
- 0 for ALL reactions to be available
- 1 for BASIC reactions to be available: 👍, ❤️, 😂, 😮, 😢, 🙏
- 2 for NONE reactions to be avaliable (turnes off using reactions in a channel)
Channel.mute and Channel.unmute to mute and unmute channel respectively (once you subcribed to a channel it will be muted)
Channel.deleteChannel that deletes the channel you created

Related Issues

The PR closes #2094, closes #2529, closes #2538, closes #2551, closes #2952

Usage Example

1. To create a channel:

const { MessageMedia, ... } = require('whatsapp-web.js');

// client initialization...

client.on('ready', async () => {
    let createdChannel = await client.createChannel('ChannelName');
    
    /**
     * The example output of the {@link createdChannel}:
     * {
     *   title: 'ChannelName',
     *   nid: {
     *     server: 'newsletter',
     *     user: 'XXXXXXXXXX',
     *     _serialized: 'XXXXXXXXXX@newsletter'
     *   },
     *   inviteLink: 'https://whatsapp.com/channel/INVITE_CODE',
     *   createdAtTs: 1700002175
     * }
     */
    console.log(createdChannel);

    // You can also provide optional parametes:
    const pic = await MessageMedia.fromUrl(
        'https://i.chzbgr.com/full/9817556992/hAA1BE0BC/bag-12',
        { unsafeMime: true }
    );

    createdChannel = await client.createChannel('ChannelName', {
        description: 'Description',
        picture: pic
    });
});

2. To subscribe to a channel:

// client initialization...

client.on('ready', async () => {
    let channelId = 'XXXXXXXXXX@newsletter';
    // True if the operation completed successfully, false otherwise
    console.log(await client.subscribeToChannel(channelId));
});

3. To unsubscribe from a channel:

// client initialization...

client.on('ready', async () => {
    let channelId = 'XXXXXXXXXX@newsletter';
    // True if the operation completed successfully, false otherwise
    console.log(await client.unsubscribeFromChannel(channelId/* , { deleteLocalModels: true } */));
});

4. To search for channels:

// client initialization...

client.on('ready', async () => {
    const foundChannels = await client.searchChannels({
        searchText: 'StandWithUS',
        sortOptions: {
            order: true
        },
        countryCodes: ['IL']
    });

    /**
     * {
     *   id: {
     *     server: 'newsletter',
     *     user: '120363189916697314',
     *     _serialized: '120363189916697314@newsletter'
     *   },
     *   t: 1697713253,
     *   unreadCount: 0,
     *   unreadDividerOffset: 0,
     *   isReadOnly: true,
     *   muteExpiration: -1,
     *   isAutoMuted: false,
     *   name: 'StandWithUs',
     *   hasUnreadMention: false,
     *   archiveAtMentionViewedInDrawer: false,
     *   hasChatBeenOpened: false,
     *   isDeprecated: false,
     *   pendingInitialLoading: false,
     *   celebrationAnimationLastPlayed: 0,
     *   hasRequestedWelcomeMsg: false,
     *   isGroup: false,
     *   isChannel: true,
     *   channelMetadata: {
     *     id: {
     *       server: 'newsletter',
     *       user: '120363189916697314',
     *       _serialized: '120363189916697314@newsletter'
     *     },
     *     creationTime: 1697713253,
     *     name: 'StandWithUs',
     *     nameUpdateTime: 1697713253815244,
     *     description: 'Supporting Israel And Fighting Antisemitism\n',
     *     descriptionUpdateTime: 1699462060238701,
     *     inviteCode: '0029Va8fZhM05MUj1A47hA0F',
     *     size: 39690,
     *     verified: true,
     *     membershipType: 'guest',
     *     suspended: false,
     *     geosuspended: false,
     *     terminated: false,
     *     messageDeliveryUpdates: [],
     *     geosuspendedCountries: [],
     *     pendingAdmins: [],
     *     subscribers: [],
     *     createdAtTs: 1697713253
     *   },
     *   lastMessage: null
     * }
     */
    console.log(foundChannels[0]); // Outputs the first found channel in an array
});

5. To get a channel by its ID:

// client initialization...

client.on('ready', async () => {
    let channelId = '120363189916697314@newsletter';

    // The output will be a `Channel` instance, if exists:
    console.log(await client.getChatById(channelId));
});

6. To get a channel by its invite code:

// client initialization...

client.on('ready', async () => {
    let channelInviteCode = '0029Va8fZhM05MUj1A47hA0F';

    // The output will be a `Channel` instance, if exists:
    console.log(await client.getChannelByInviteCode(channelInviteCode));
});

7. To get all cached channels:

// client initialization...

client.on('ready', async () => {
    // The output will be an array of your cached `Channel` objects:
    console.log(await client.getChannels());
});

8. To send a channel admin invitation to a user as a channel admin:

// client initialization...

client.on('ready', async () => {
    const userId = 'XXXXXXXXXX@c.us';
    const channelId = 'YYYYYYYYYY@newsletter';
    const greeting = 'Hello, please become a channel admin';

    // True if the operation completed successfully, false otherwise
    console.log(await client.sendChannelAdminInvite(userId, channelId, { comment: greeting }));

    // OR
    const channel = await getChatById(channelId);
    await channel.sendChannelAdminInvite(userId, { comment: greeting });
});

9. To accept a channel admin invitation as a regular user:

// client initialization...

client.on('ready', async () => {
    const channelId = 'YYYYYYYYYY@newsletter';

    // True if the operation completed successfully, false otherwise
    console.log(await client.acceptChannelAdminInvite(channelId));

    // OR
    const channel = await getChatById(channelId);
    await channel.acceptChannelAdminInvite();
});

10. To revoke a channel admin invitation as a channel admin:

// client initialization...

client.on('ready', async () => {
    const userId = 'XXXXXXXXXX@c.us';
    const channelId = 'YYYYYYYYYY@newsletter';

    // True if the operation completed successfully, false otherwise
    console.log(await client.revokeChannelAdminInvite(channelId, userId));

    // OR
    const channel = await getChatById(channelId);
    await channel.revokeChannelAdminInvite(userId);
});

11. To demote a channel admin:

// client initialization...

client.on('ready', async () => {
    const userId = 'XXXXXXXXXX@c.us';
    const channelId = 'YYYYYYYYYY@newsletter';

    // True if the operation completed successfully, false otherwise
    console.log(await client.demoteChannelAdmin(channelId, userId));

    // OR
    const channel = await getChatById(channelId);
    await channel.demoteChannelAdmin(userId);
});

12. To get channel subscribers:

// client initialization...

client.on('ready', async () => {
    const channelId = 'YYYYYYYYYY@newsletter';
    const channel = await getChatById(channelId);
    const limit = 5;

    /**
     * The example of an output (in my case there is only one subscriber):
     * 
     * [
     *   {
     *     contact: {
     *       id: {
     *         server: 'c.us',
     *         user: 'XXXXXXXXX',
     *         _serialized: 'XXXXXXXXX@c.us'
     *       },
     *       name: 'Test',
     *       shortName: 'Test',
     *       pushname: 'Test',
     *       type: 'in',
     *       isBusiness: false,
     *       isEnterprise: false,
     *       isSmb: false,
     *       isContactSyncCompleted: 1,
     *       textStatusLastUpdateTime: -1,
     *       isMe: false,
     *       isUser: true,
     *       isGroup: false,
     *       isWAContact: true,
     *       isMyContact: true,
     *       isBlocked: false,
     *       userid: 'XXXXXXXXX'
     *     },
     *     role: 'subscriber'
     *   }
     * ]
     */
    console.log(await channel.getSubscribers(limit));
});

13. To set channel subject (name):

// client initialization...

client.on('ready', async () => {
    const channelId = 'YYYYYYYYYY@newsletter';
    const channel = await getChatById(channelId);
    const newSubject = 'NewSubject';
    // True if the operation completed successfully, false otherwise
    console.log(await channel.setSubject(newSubject));
});

14. To set channel description:

// client initialization...

client.on('ready', async () => {
    const channelId = 'YYYYYYYYYY@newsletter';
    const channel = await getChatById(channelId);
    const newDescription = 'NewSubject';
    // True if the operation completed successfully, false otherwise
    console.log(await channel.setDescription(newDescription));
});

15. To set channel profile picture:

const { MessageMedia, ... } = require('whatsapp-web.js');

// client initialization...

client.on('ready', async () => {
    const channelId = 'YYYYYYYYYY@newsletter';
    const channel = await getChatById(channelId);
    const newPicture = await MessageMedia.fromUrl(
        'https://i.redd.it/l9vklw5gh4841.jpg',
        { unsafeMime: true }
    );
    // True if the operation completed successfully, false otherwise
    console.log(await channel.setProfilePicture(newPicture));
});

16. To set a channel available reactions:

// client initialization...

client.on('ready', async () => {
    const channelId = 'YYYYYYYYYY@newsletter';
    const channel = await getChatById(channelId);

    // True if the operation completed successfully, false otherwise
    console.log(await channel.setReactionSetting(0)); // Allows all reactions
    console.log(await channel.setReactionSetting(1)); // Allows default reactions (👍, ❤️, 😂, 😮, 😢, 🙏)
    console.log(await channel.setReactionSetting(2)); // Turns off reactions
});

17. To mute/unmute a channel:

// client initialization...

client.on('ready', async () => {
    const channelId = 'YYYYYYYYYY@newsletter';
    const channel = await getChatById(channelId);

    // True if the operation completed successfully, false otherwise
    console.log(await channel.unmute());
    console.log(await channel.mute());
});

18. To delete a channel:

// client initialization...

client.on('ready', async () => {
    const channelId = 'YYYYYYYYYY@newsletter';
    const channel = await getChatById(channelId);

    // True if the operation completed successfully, false otherwise
    console.log(await channel.deleteChannel());
});

To test this PR by yourself you should do two steps:

1. Install the PR by running one of the following commands:

NPM

npm install github:alechkos/whatsapp-web.js#channels

YARN

yarn add github:alechkos/whatsapp-web.js#channels

2. Lock your WWeb version on 2.2412.54:

const wwebVersion = '2.2412.54';

const client = new Client({
    authStrategy: new LocalAuth(), // your authstrategy here
    puppeteer: {
        // puppeteer args here
    },
    // locking the wweb version
    webVersionCache: {
        type: 'remote',
        remotePath: `https://raw.githubusercontent.com/wppconnect-team/wa-version/main/html/${wwebVersion}.html`,
    },
});

If you encounter any errors while testing this PR, please provide in a comment:

The code you've used without any sensitive information (use syntax highlighting for more readability)
The error you got
The library version
The WWeb version: console.log(await client.getWWebVersion());
The browser (Chrome/Chromium)

Important

You have to reapply the PR each time it is changed (new commits were pushed since your last application)

How Has The PR Been Tested (latest test on 22.04.2024)

Tested with a code provided in usage example.

Tested On:

Types of accounts:

Personal
Buisness

Environment:

Android 10:
- WhatsApp: latest
- WA Business: latest
Windows 10:
- WWebJS: v1.23.1-alpha.5
- WWeb: v2.2412.54
- Puppeteer: v18.2.1
- Node: v18.17.1
- Chrome: latest

Types of Changes

Dependency change
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix/feature that would cause existing functionality to change)

Checklist

My code follows the code style of this project
I have updated the usage example accordingly (example.js)
I have updated the documentation accordingly (index.d.ts)

bruninoit · 2023-11-08T12:07:03Z

sending photo in channels has some problems

alechkos · 2023-11-09T05:52:01Z

@bruninoit

sending photo in channels has some problems

wanna tell me what they are?

bruninoit · 2023-11-09T15:32:13Z

wanna tell me what they are?

After sending an image in a channel...
If you access the channel from the channel owner and try to press the button to send the image again, WhatsApp crashes
If you access the channel from a channel subscriber and try to download the image, it won't download.
I used the exact same code to send a photo in private chat and it works correctly, while sending in a channel there are these problems.

devsakae · 2023-11-09T18:49:10Z

Tested and worked great here. Here is how I did it.

Step 1: Install @alechkos wweb.js version:

npm install github:alechkos/whatsapp-web.js#channels --save

Step 2: Create a channel and get it's ID:

const channelId = (await client.createChannel('MyChannel))?.nid._serialized
console.log('My channel id is:', channelId)

Step 3: Start publishing:

await client.sendMessage(channelId, 'Hello World')

devsakae · 2023-11-09T18:51:07Z

One question, tho. How to publish media?

alechkos · 2023-11-09T18:55:18Z

@devsakae

One question, tho. How to publish media?

sending media is still doesn't work

devsakae · 2023-11-16T19:54:29Z

I used the exact same code to send a photo in private chat and it works correctly, while sending in a channel there are these problems.

Same here. I even though it was my connection, but every other media downloaded from channels work great.

It's a bug

alechkos · 2023-11-21T06:14:41Z

@devsakae @bruninoit

Thank you for testing, sendMessage has been fixed and now supports these message types to send: text, image, sticker, gif, or video

src/util/Injected.js

Co-authored-by: Sven Neumann <s.neumann@websix.de>

fixes pedroslopez#2952

alechkos · 2024-05-01T19:49:29Z

Now you can send polls in channels:

const { Client, Poll, /* others */ } = require('whatsapp-web.js');

// client initialization...

const channelId = 'your_channel_id@newsletter';

client.on('ready', async () => {
    await client.sendMessage(channelId, new Poll('Cats or Dogs?', ['Cats', 'Dogs']));

    // Also you can send polls with multiple answers:
    await client.sendMessage(channelId, new Poll('Cats or Dogs?', ['Cats', 'Dogs'], { allowMultipleAnswers: true }));
});

shirser121 · 2024-05-02T06:58:23Z

Should we support get channel by using getChatById?

alechkos · 2024-05-02T07:01:49Z

@shirser121

Should we support get channel by using getChatById?

Definitely yes

shirser121 · 2024-05-02T08:11:12Z

src/util/Injected.js

+            const sendChannelMsgResponse = await window.Store.SendChannelMessage.sendNewsletterMessageJob({
+                msg: msg,
+                type: message.type === 'chat' ? 'text' : isMedia ? 'media' : 'pollCreation',
+                newsletterJid: chat.id.toJid(),


Maybe we should allow some extra option so pepole can control some fileds

@shirser121

Maybe we should allow some extra option so pepole can control some fileds

Unfortunately, once you you change those props, the message is not being sent.
But I have not tested it a lot.
You can try to play with adding some extra properties. If it will work for you, just suggest your changes and I'll add them as your commit :)

@shirser121
Don't we already have extra options here?

shirser121 · 2024-05-02T09:37:20Z

src/util/Injected.js

+                ...(isMedia ? { mediaMetadata: msg.avParams() } : {})
+            });
+
+            if (sendChannelMsgResponse.success) {


If success is false, what happened?

@shirser121

If success is false, what happened?

Once the response is success, we update the timestamp and serverId props

Otherwise we don't

alechkos added 2 commits November 1, 2023 03:12

window.injectToFunction clarifications

b92c530

added createChannel method

562d7b0

This was referenced Nov 2, 2023

Channels (new feature) support #2529

Open

Not recognizing channel messages português: ele não está reconhecendo mensagens de canais #2538

Open

Bug When sending a message to the channel #2551

Open

New Whatsapp Channels #2611

Closed

alechkos force-pushed the channels branch from 1757130 to 537f907 Compare November 4, 2023 00:56

alechkos added 5 commits November 4, 2023 20:46

initial Channel class structure

197e67f

added getChannelById and getChannels methods

cc78a0d

added 4 methods to change channel metadata

2baf22a

added deleteChannel method

11c184e

added subscribe to/unsubscribe from channel methods

1ba8bec

alechkos force-pushed the channels branch from 537f907 to 11c184e Compare November 4, 2023 19:02

alechkos added 5 commits November 5, 2023 18:08

ecmaVersion updated to 2022

ea82240

added searchChannels method

0117c76

refactoring of: getChat, getChannel, getChatModel, getChannelModel

70f6428

removed Channel.canSend

0c61d59

sendMessage updated to support channels [p1]

7194588

alechkos added 4 commits November 13, 2023 09:36

createChannel: returns string if an error occupied

09739b8

added getSubscribers

ac2cd4e

added mute/unmute methods

321747a

searchChannels: minor update

c2c79e9

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

Merge branch 'main' into channels

e9392ec

This comment was marked as resolved.

Sign in to view

alechkos marked this pull request as draft April 16, 2024 02:53

Repository owner locked and limited conversation to collaborators Apr 16, 2024

Repository owner unlocked this conversation Apr 19, 2024

themazim reviewed Apr 19, 2024

View reviewed changes

src/util/Injected.js Outdated Show resolved Hide resolved

sendNewsletterMessageJob requires a proper Msg Object in 2.24xx (#10)

fce9bdb

Co-authored-by: Sven Neumann <s.neumann@websix.de>

alechkos marked this pull request as ready for review April 22, 2024 05:39

alechkos added 6 commits April 22, 2024 15:27

Merge branch 'main' into channels

5ea5018

style: fix broken link in readme file

926198f

Merge branch 'main' into channels

fee0deb

Merge branch 'main' into channels

0ea8853

Merge branch 'main' into channels

883507d

fix: only directPath determines whether hasMedia or not

51b1943

fixes pedroslopez#2952

alechkos force-pushed the channels branch from 1d276dd to 51b1943 Compare April 30, 2024 18:29

alechkos added 4 commits April 30, 2024 22:31

Merge branch 'main' into channels

e2d156b

Merge branch 'main' into channels

d2d74c9

fix: get rid of unnecessary 'await'

a3827cd

feat: add option to send polls in channels

96ad809

refactor: get channel instances with 'getChatById'

3370e57

shirser121 reviewed May 2, 2024

View reviewed changes

alechkos added 2 commits May 2, 2024 11:22

chore: fix eslint

e414dea

fix: fatal error

05e9eab

shirser121 reviewed May 2, 2024

View reviewed changes

This comment has been minimized.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: `Channel` #2620

feat: `Channel` #2620

alechkos commented Nov 2, 2023 •

edited

bruninoit commented Nov 8, 2023

alechkos commented Nov 9, 2023 •

edited

bruninoit commented Nov 9, 2023 •

edited

devsakae commented Nov 9, 2023 •

edited

devsakae commented Nov 9, 2023

alechkos commented Nov 9, 2023 •

edited

devsakae commented Nov 16, 2023

alechkos commented Nov 21, 2023 •

edited

This comment was marked as outdated.

This comment was marked as resolved.

This comment was marked as resolved.

alechkos commented May 1, 2024 •

edited

shirser121 commented May 2, 2024

alechkos commented May 2, 2024

shirser121 May 2, 2024

alechkos May 2, 2024

alechkos May 2, 2024

shirser121 May 2, 2024

alechkos May 2, 2024 •

edited

alechkos May 2, 2024

This comment has been minimized.

feat: Channel #2620

Are you sure you want to change the base?

feat: Channel #2620

Conversation

alechkos commented Nov 2, 2023 • edited

Table of Contents

- Description

- Related Issues

- Usage Example

- I Want to Test this PR

- I Got an Error While Testing This PR ❌

- How Has the PR Been Tested (latest test on 22.04.2024)

- Types of Changes

1. To create a channel:

2. To subscribe to a channel:

3. To unsubscribe from a channel:

4. To search for channels:

5. To get a channel by its ID:

6. To get a channel by its invite code:

7. To get all cached channels:

8. To send a channel admin invitation to a user as a channel admin:

9. To accept a channel admin invitation as a regular user:

10. To revoke a channel admin invitation as a channel admin:

11. To demote a channel admin:

12. To get channel subscribers:

13. To set channel subject (name):

14. To set channel description:

15. To set channel profile picture:

16. To set a channel available reactions:

17. To mute/unmute a channel:

18. To delete a channel:

1. Install the PR by running one of the following commands:

2. Lock your WWeb version on 2.2412.54:

How Has The PR Been Tested (latest test on 22.04.2024)

Tested On:

Types of accounts:

Environment:

Checklist

bruninoit commented Nov 8, 2023

alechkos commented Nov 9, 2023 • edited

bruninoit commented Nov 9, 2023 • edited

devsakae commented Nov 9, 2023 • edited

devsakae commented Nov 9, 2023

alechkos commented Nov 9, 2023 • edited

devsakae commented Nov 16, 2023

alechkos commented Nov 21, 2023 • edited

This comment was marked as outdated.

This comment was marked as resolved.

This comment was marked as resolved.

alechkos commented May 1, 2024 • edited

Now you can send polls in channels:

shirser121 commented May 2, 2024

alechkos commented May 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alechkos May 2, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

feat: `Channel` #2620

feat: `Channel` #2620

alechkos commented Nov 2, 2023 •

edited

alechkos commented Nov 9, 2023 •

edited

bruninoit commented Nov 9, 2023 •

edited

devsakae commented Nov 9, 2023 •

edited

alechkos commented Nov 9, 2023 •

edited

alechkos commented Nov 21, 2023 •

edited

alechkos commented May 1, 2024 •

edited

alechkos May 2, 2024 •

edited