feat: `vote_update` event #2596

alechkos · 2023-10-23T19:16:07Z

client.on('vote_update', (vote) => {
    /**
     * The {@link vote} that was affected:
     * 
     * {
     *   voter: '[email protected]',
     *   selectedOptions: [ { name: 'B', localId: 1 } ],
     *   interractedAtTs: 1698195555555,
     *   parentMessage: {
     *     ...,
     *     pollName: 'PollName',
     *     pollOptions: [
     *       { name: 'A', localId: 0 },
     *       { name: 'B', localId: 1 }
     *     ],
     *     allowMultipleAnswers: true,
     *     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
     *     ]
     *   }
     * }
     */
    console.log(vote);
});

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#polls-ext

YARN

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

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 by selecting and deselecting poll options in both single-option and multiple-option polls.

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)

Co-authored-by: tuyuribr <[email protected]>

seowzhenjun0126 · 2024-04-23T00:43:27Z

Will this work for WhatsApp web 2.3x for now / future? Thanks!

alechkos · 2024-04-23T03:15:05Z

@seowzhenjun0126

Will this work for WhatsApp web 2.3x for now / future? Thanks!

As soon as the patch is a part of main, I will add required changes to support wweb 2.3xxx

seowzhenjun0126 · 2024-04-23T03:40:30Z

Got it. Thanks for your help!

felipeaffonsobsi · 2024-04-24T22:07:56Z

Não consigo utilizar e ler o voto do usuário. Alguém pode me ajudar?

alechkos · 2024-04-24T22:09:33Z

@felipeaffonsobsi

Não consigo utilizar e ler o voto do usuário. Alguém pode me ajudar?

#2596 (comment)

felipeaffonsobsi · 2024-04-25T00:57:38Z

@felipeaffonsobsi

Não consigo utilizar e ler o voto do usuário. Alguém pode me ajudar?

#2596 (comentário)

você reenviou essa página, desculpa mas isso não me ajudou.

* Merge branch 'add-polls' into polls-ext * added listener to poll votes * added isUnvote property * added option for custom message secret * usage example updated * added logic for catching removed votes * usage example updated * fixed logic for poll vote events * temp usage example * No more `isCurrentState` * messageSecret converted to array Co-authored-by: tuyuribr <[email protected]> * docs updated * we already have messageSecret in vote.parentMessage * PollVote.selectedOptions changed to be similar to pollOptions * docs fixed * window.injectToFunction clarifications * minor clarifications * fix: typo * style: fix broken link in readme file --------- Co-authored-by: tuyuribr <[email protected]>

The code is reference from pedroslopez#2596

This reverts commit 9cac8fd.

crocodile2024 · 2024-06-09T00:47:57Z

Hello,
my bot do not trigger the vote_update Event.

This is my code:
`const { Client, LocalAuth } = require("whatsapp-web.js");
const qrcode = require("qrcode-terminal");
const axios = require("axios");
const webhookURL = "https://example.com/webhooks/logger.php";

const client = new Client({
puppeteer: {
headless: true,
args: ["--no-sandbox"],
},
authStrategy: new LocalAuth(),
webVersionCache: {
type: "remote",
remotePath:
"https://raw.githubusercontent.com/wppconnect-team/wa-version/main/html/2.2411.2.html",
},
authTimeoutMs: 300000, // Optional: timeout for authentication in milliseconds
qrTimeout: 30000, // Optional: timeout for QR code generation
});

client.on("qr", (qr) => {
qrcode.generate(qr, { small: true });
const data = {
event: "qr",
msg: "",
qr: qr
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
});

client.on("ready", () => {
console.log("Client is ready!");
const data = {
event: "ready",
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
});

client.on("authenticated", () => {
console.log("Client is authenticated!");
const data = {
event: "authenticated",
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
});

client.on("auth_failure", (msg) => {
console.error("Authentication failure", msg);
const data = {
event: "auth_failure",
msg: msg
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
});

client.on("message", async (msg) => {
console.log("MESSAGE RECEIVED", msg);
const data = {
event: "message",
msg: msg
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
if (msg.body === "!ping") {
msg.reply("pong");
}

if (msg.body === "!smart_1") {
    const chat = await msg.getChat();
    // simulates typing in the chat
    await chat.sendStateTyping();
    axios.get("http://192.168.178.46/cm?cmnd=status%208").then(response => {
        if (response.status === 200) {
            try {
                console.log(response);
                //const d = JSON.parse(response.data);
                const d = response.data;
                m = "Aktuelle Werte:\n   Energie:\n     Heute: " + d.StatusSNS.ENERGY.Today + " kWh\n     Gestern: " + d.StatusSNS.ENERGY.Yesterday + " kWh\n     Gesamt: " + d.StatusSNS.ENERGY.Total + " kWh\n   Strom: " + d.StatusSNS.ENERGY.Current + " A\n   Spannung: " + d.StatusSNS.ENERGY.Voltage + " V";
                //chat.clearState();
                //msg.reply(m);
            } catch (e) {
                console.error(e)
            }
        }
    }).catch(error => {
        console.error("Error: " + error);
        msg.reply("Error: " + error);
    });

    axios.get("http://192.168.178.46/cm?cmnd=status%2011").then(response => {
        if (response.status === 200) {
            try {
                console.log(response);
                //const d = JSON.parse(response.data);
                const d = response.data;
                m = m + "\n   Schaltzustand: " + d.StatusSTS.POWER;
                chat.clearState();
                msg.reply(m);
            } catch (e) {
                console.error(e)
            }
        }
    }).catch(error => {
        console.error("Error: " + error);
        msg.reply("Error: " + error);
    });
}

if (msg.body === "!smart_2") {
    const chat = await msg.getChat();
    // simulates typing in the chat
    await chat.sendStateTyping();
    axios.get("http://192.168.178.51/cm?cmnd=status%208").then(response => {
        if (response.status === 200) {
            try {
                console.log(response);
                //const d = JSON.parse(response.data);
                const d = response.data;
                m = "Aktuelle Werte:\n   Energie:\n     Heute: " + d.StatusSNS.ENERGY.Today + " kWh\n     Gestern: " + d.StatusSNS.ENERGY.Yesterday + " kWh\n     Gesamt: " + d.StatusSNS.ENERGY.Total + " kWh\n   Strom: " + d.StatusSNS.ENERGY.Current + " A\n   Spannung: " + d.StatusSNS.ENERGY.Voltage + " V";
                //chat.clearState();
                //msg.reply(m);
            } catch (e) {
                console.error(e)
            }
        }
    }).catch(error => {
        console.error("Error: " + error);
        msg.reply("Error: " + error);
    });

    axios.get("http://192.168.178.51/cm?cmnd=status%2011").then(response => {
        if (response.status === 200) {
            try {
                console.log(response);
                //const d = JSON.parse(response.data);
                const d = response.data;
                m = m + "\n   Schaltzustand: " + d.StatusSTS.POWER;
                chat.clearState();
                msg.reply(m);
            } catch (e) {
                console.error(e)
            }
        }
    }).catch(error => {
        console.error("Error: " + error);
        msg.reply("Error: " + error);
    });
}

if (msg.body === "!smart_1_toggle") {
    const chat = await msg.getChat();
    // simulates typing in the chat
    await chat.sendStateTyping();
    axios.get("http://192.168.178.46/cm?cmnd=Power%20TOGGLE").then(response => {
        if (response.status === 200) {
            try {
                console.log(response);
                //const d = JSON.parse(response.data);
                const d = response.data;
                m = "Neuer Schaltzustand: " + d.POWER;
                chat.clearState();
                msg.reply(m);
            } catch (e) {
                console.error(e)
            }
        }
    }).catch(error => {
        console.error("Error: " + error);
        msg.reply("Error: " + error);
    });
}

if (msg.body === "!smart_2_toggle") {
    const chat = await msg.getChat();
    // simulates typing in the chat
    await chat.sendStateTyping();
    axios.get("http://192.168.178.51/cm?cmnd=Power%20TOGGLE").then(response => {
        if (response.status === 200) {
            try {
                console.log(response);
                //const d = JSON.parse(response.data);
                const d = response.data;
                m = "Neuer Schaltzustand: " + d.POWER;
                chat.clearState();
                msg.reply(m);
            } catch (e) {
                console.error(e)
            }
        }
    }).catch(error => {
        console.error("Error: " + error);
        msg.reply("Error: " + error);
    });
}

});

client.on("group_join", (notification) => {
const data = {
event: "group_join",
msg: "",
notification: notification
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
// User has joined or been added to the group.
console.log("join", notification);
notification.reply("User joined.");
});

client.on("group_leave", (notification) => {
const data = {
event: "group_leave",
notification: notification,
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
// User has left or been kicked from the group.
console.log("leave", notification);
notification.reply("User left.");
});

client.on("group_update", (notification) => {
const data = {
event: "group_update",
notification: notification,
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
// Group picture, subject or description has been updated.
console.log("update", notification);
});

client.on("change_state", state => {
const data = {
event: "change_state",
state: state,
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
console.log("CHANGE STATE", state);
});

// Change to false if you don"t want to reject incoming calls
let rejectCalls = true;

client.on("call", async (call) => {
const data = {
event: "call",
call: call,
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
console.log("Call received, rejecting. GOTO Line 261 to disable", call);
if (rejectCalls) await call.reject();
await client.sendMessage(call.from, [${call.fromMe ? "Outgoing" : "Incoming"}] Phone call from ${call.from}, type ${call.isGroup ? "group" : ""} ${call.isVideo ? "video" : "audio"} call. ${rejectCalls ? "This call was automatically rejected by the script." : ""});
});

client.on("disconnected", (reason) => {
const data = {
event: "disconnected",
reason: reason,
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
console.log("Client was logged out", reason);
});

client.on("contact_changed", async (message, oldId, newId, isContact) => {
const data = {
event: "contact_changed",
message: message,
oldId: oldId,
newId: newId,
isContact: isContact
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
/** The time the event occurred. */
const eventTime = (new Date(message.timestamp * 1000)).toLocaleString();

console.log(
    `The contact ${oldId.slice(0, -5)}` +
    `${!isContact ? " that participates in group " +
        `${(await client.getChatById(message.to ?? message.from)).name} ` : " "}` +
    `changed their phone number\nat ${eventTime}.\n` +
    `Their new phone number is ${newId.slice(0, -5)}.\n`);

/**
 * Information about the @param {message}:
 * 
 * 1. If a notification was emitted due to a group participant changing their phone number:
 * @param {message.author} is a participant"s id before the change.
 * @param {message.recipients[0]} is a participant"s id after the change (a new one).
 * 
 * 1.1 If the contact who changed their number WAS in the current user"s contact list at the time of the change:
 * @param {message.to} is a group chat id the event was emitted in.
 * @param {message.from} is a current user"s id that got an notification message in the group.
 * Also the @param {message.fromMe} is TRUE.
 * 
 * 1.2 Otherwise:
 * @param {message.from} is a group chat id the event was emitted in.
 * @param {message.to} is @type {undefined}.
 * Also @param {message.fromMe} is FALSE.
 * 
 * 2. If a notification was emitted due to a contact changing their phone number:
 * @param {message.templateParams} is an array of two user"s ids:
 * the old (before the change) and a new one, stored in alphabetical order.
 * @param {message.from} is a current user"s id that has a chat with a user,
 * whos phone number was changed.
 * @param {message.to} is a user"s id (after the change), the current user has a chat with.
 */

});

client.on("group_admin_changed", (notification) => {
const data = {
event: "group_admin_changed",
notification: notification,
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
if (notification.type === "promote") {
/**
* Emitted when a current user is promoted to an admin.
* {@link notification.author} is a user who performs the action of promoting/demoting the current user.
/
console.log(You were promoted by ${notification.author});
} else if (notification.type === "demote")
/* Emitted when a current user is demoted to a regular user. */
console.log(You were demoted by ${notification.author});
});

client.on("group_membership_request", async (notification) => {
const data = {
event: "group_membership_request",
notification: notification,
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
/**
* The example of the {@link notification} output:
* {
* id: {
* fromMe: false,
* remote: "[email protected]",
* id: "123123123132132132",
* participant: "[email protected]",
* _serialized: "false_groupId@[email protected]"
* },
* body: "",
* type: "created_membership_requests",
* timestamp: 1694456538,
* chatId: "[email protected]",
* author: "[email protected]",
* recipientIds: []
* }
*
/
console.log(notification);
/* You can approve or reject the newly appeared membership request: */
await client.approveGroupMembershipRequestss(notification.chatId, notification.author);
await client.rejectGroupMembershipRequests(notification.chatId, notification.author);
});

client.on("vote_update", (vote) => {
const data = {
event: "vote_update",
vote: vote,
msg: ""
};
axios.post(webhookURL, data)
.then(response => {
console.log(Status: ${response.status});
console.log("Body: ", response.data);
})
.catch(error => {
console.error(Error: ${error});
});
/** The vote that was affected: */
console.log(vote);
});

client.on("message_ack", (msg, ack) => {
/*
== ACK VALUES ==
ACK_ERROR: -1
ACK_PENDING: 0
ACK_SERVER: 1
ACK_DEVICE: 2
ACK_READ: 3
ACK_PLAYED: 4
*/

const data = {
    event: "message_ack",
    ack: ack,
    msg: msg
};
axios.post(webhookURL, data)
    .then(response => {
        console.log(`Status: ${response.status}`);
        console.log("Body: ", response.data);
    })
    .catch(error => {
        console.error(`Error: ${error}`);
    });

if (ack == 3) {
    // The message was read
console.log("Nachricht wurde gelesen:");
console.log(msg);
}

});

client
.initialize()
.then(() => {
console.log("Client initialized successfully");
})
.catch((err) => {
console.error("Error initializing client", err);
});`

Sorry the code format do not work.
Has an idea why the vote_update event is not triggered?

Crocodile202405

alechkos and others added 18 commits October 9, 2023 10:31

Merge branch 'add-polls' into polls-ext

88692e7

added listener to poll votes

55a386d

added isUnvote property

52f79e1

Merge branch 'main' into polls-ext

075e45c

Merge branch 'main' into polls-ext

2867009

Merge branch 'main' into polls-ext

6817d18

Merge branch 'main' into polls-ext

fb7ade3

added option for custom message secret

d68aac1

usage example updated

fadc728

Merge branch 'main' into polls-ext

ec2f59a

added logic for catching removed votes

667d488

usage example updated

579bcb8

Merge branch 'main' into polls-ext

d6751cd

fixed logic for poll vote events

4c7e11e

temp usage example

6081db6

No more isCurrentState

6d0bec6

messageSecret converted to array

ba4995a

Co-authored-by: tuyuribr <[email protected]>

docs updated

d5c1ec5

alechkos changed the title ~~feat: poll vote event~~ feat: poll_update event Oct 25, 2023

alechkos added 2 commits October 25, 2023 05:33

we already have messageSecret in vote.parentMessage

a9fad78

PollVote.selectedOptions changed to be similar to pollOptions

1698df2

alechkos marked this pull request as ready for review October 25, 2023 02:47

alechkos added 2 commits October 27, 2023 01:17

docs fixed

b4d6834

window.injectToFunction clarifications

e7d8c39

tuyuribr approved these changes Nov 1, 2023

View reviewed changes

minor clarifications

70e9729

This was referenced Nov 11, 2023

Receive poll message voting #2626

Closed

How to trigger polls ?? #2494

Closed

alechkos changed the title ~~feat: poll_update event~~ feat: vote_update event Nov 14, 2023

Merge branch 'main' into polls-ext

20d238e

Repository owner deleted a comment from abimtekno Apr 4, 2024

Eraxorice mentioned this pull request Apr 4, 2024

feat: pin/unpin messages #2692

Merged

7 tasks

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

auto-merge was automatically disabled April 16, 2024 02:52
Pull request was converted to draft

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

Repository owner unlocked this conversation Apr 19, 2024

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

alechkos added 2 commits April 22, 2024 15:27

Merge branch 'main' into polls-ext

5d3d4dc

style: fix broken link in readme file

2c3313e

alechkos added 3 commits April 27, 2024 20:39

Merge branch 'main' into polls-ext

b42690a

Merge branch 'main' into polls-ext

61c2eae

Merge branch 'main' into polls-ext

a92a95b

alechkos requested review from PurpShell and shirser121 and removed request for aliyss and shirser121 April 29, 2024 10:13

alechkos enabled auto-merge (squash) April 29, 2024 10:20

refactor: restore default obj prop

bee5d1b

PurpShell approved these changes Apr 30, 2024

View reviewed changes

alechkos merged commit 01714fe into pedroslopez:main Apr 30, 2024
1 check passed

seowzhenjun0126 added a commit to seowzhenjun0126/whatsapp-web.js that referenced this pull request May 6, 2024

Re-add code for "vote_update" feature

38082bf

The code is reference from pedroslopez#2596

ninajika added a commit to KDevRev/whatsapp-web.js that referenced this pull request May 7, 2024

Revert "feat: vote_update event (pedroslopez#2596)"

bb2b696

This reverts commit 9cac8fd.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: `vote_update` event #2596

feat: `vote_update` event #2596

alechkos commented Oct 23, 2023 •

edited

seowzhenjun0126 commented Apr 23, 2024

alechkos commented Apr 23, 2024

seowzhenjun0126 commented Apr 23, 2024

felipeaffonsobsi commented Apr 24, 2024

alechkos commented Apr 24, 2024 •

edited

felipeaffonsobsi commented Apr 25, 2024

crocodile2024 commented Jun 9, 2024 •

edited

feat: vote_update event #2596

feat: vote_update event #2596

Conversation

alechkos commented Oct 23, 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

Special thanks to @tuyuribr for his help

Description

Related Issues

Usage Example

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

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

2. Lock your WWeb version on 2.2412.54:

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

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

Tested On:

Types of accounts:

Environment:

Types of Changes

Checklist

seowzhenjun0126 commented Apr 23, 2024

alechkos commented Apr 23, 2024

seowzhenjun0126 commented Apr 23, 2024

felipeaffonsobsi commented Apr 24, 2024

alechkos commented Apr 24, 2024 • edited

felipeaffonsobsi commented Apr 25, 2024

crocodile2024 commented Jun 9, 2024 • edited

feat: `vote_update` event #2596

feat: `vote_update` event #2596

alechkos commented Oct 23, 2023 •

edited

alechkos commented Apr 24, 2024 •

edited

crocodile2024 commented Jun 9, 2024 •

edited