feat: Event messages

[alechkos]

PR Details

Description

The PR adds a new functionality for scheduled event messages:

• Updated Client.sendMessage which supports now the sending of scheduled event messages.
• Client.createCallLink for generating a WhatsApp call link (video call or voice call).
• Client.sendResponseToScheduledEvent for responding to the scheduled event message, indicating whether a user is going to attend the event or not.
• Message.editScheduledEvent for editing the existing event message or for canceling the event.

---

Usage Example

1. To create and send a scheduled event message:

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

// client initialization...

client.on('ready', async () => {
    const event = new ScheduledEvent(
        /** The event name: */
        'Birthday Party',
        /** The event start time: */
        new Date(2025, 1, 25, 15, 32),
        /** Optional properties: */
        {
            /** ScheduledEvent description: */
            description: 'Happy Birthday!',
            /** The event end time: */
            endTime: new Date(2025, 1, 26, 12),
            /** The location of an event: */
            location: 'Central Park',
            /** The call type ('voice' | 'video') to generate a WhatsApp call link: */
            callType: 'voice',
            /** The event can be sent as already canceled, for fun (false by default): */
            isEventCanceled: false,
            /** Can be used as an event message ID, it presents a custom array of 32 numbers, that array will be converted to Uint8Array inside the browser context: */
            messageSecret: [
                    1, 2, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
                ]
        });

    const familyGroupId = '[email protected]';
    const eventMsgId = (await client.sendMessage(familyGroupId, event)).id._serialized;
    console.log(eventMsgId);
});

2. To create a WhatsApp call link:

// client initialization...

client.on('ready', async () => {
    const videoCallLink = await client.createCallLink(new Date(2025, 1, 26, 12), 'video');
    console.log(videoCallLink);

    const voiceCallLink = await client.createCallLink(new Date(2025, 1, 26, 12), 'voice');
    console.log(voiceCallLink);
});

3. To respond to a scheduled event:

// client initialization...

client.on('message', async (msg) => {
    /**
     * Valid response values are:
     * 
     * 0 for NONE response (removes a previous response)
     * 1 for GOING
     * 2 for NOT GOING
     * 3 for MAYBE going
     */
    const myResponse = 1;

    if (msg.type === 'scheduled_event_creation') {
        const msgId = msg.id._serialized;
        await client.sendResponseToScheduledEvent(myResponse, msgId);
    }
});

4. To edit a scheduled event message (or to cancel an event):

// client initialization...

client.on('message', async (msg) => {
    if (msg.type === 'scheduled_event_creation') {
        const editedEvent = new ScheduledEvent(/* Provide edited values here */);
        await msg.editEvent(editedEvent);
    }
});

---

To try this PR by yourself you can run one of the following commands:

• NPM

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

• YARN

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

---

How Has The PR Been Tested

Tested with a code provided in usage example.

---

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)

[Halphas]

wow love it!

[Halphas]

The event edit is not getting and unique identifier? how is it mapping the new Event(....) to the one i want to edit?
like i would probably save some event_id and then later when editiing try to do something like getEventById(event_id) = new Event(...) but in this case we do not have an event id right?

[tuyuribr]

LGTM... But I don't think we should use the name "Event", maybe it will cause confusion in other parts

[alechkos]

LGTM... But I don't think we should use the name "Event", maybe it will cause confusion in other parts

@tuyuribr fixed