Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@wppconnect-team/wppconnect

wppconnect-team18.7kLGPL-3.0-or-later1.37.2TypeScript support: included

WPPConnect is an open source project developed by the JavaScript community with the aim of exporting functions from WhatsApp Web to the node, which can be used to support the creation of any interaction, such as customer service, media sending, intelligen

whatsapp, javascript, bot, chat bot, bot, typescript, automatization, puppeteer

readme

WPPConnect 📞

WPPConnect Banner

npm version Downloads Average time to resolve an issue Percentage of issues still open Build Status Lint Status release-it

WPPConnect is an open source project developed by the JavaScript community with the aim of exporting functions from WhatsApp Web to the node, which can be used to support the creation of any interaction, such as customer service, media sending, intelligence recognition based on phrases artificial and many other things, use your imagination... 😀🤔💭

Getting StartedBasic FunctionDocumentation

Our online channels

Discord Telegram Group WhatsApp Group YouTube

Functions

| | | | ---------------------------------------------------------- | --- | | Automatic QR Refresh | ✔ | | Send text, image, video, audio and docs | ✔ | | Get contacts, chats, groups, group members, Block List | ✔ | | Send contacts | ✔ | | Send stickers | ✔ | | Send stickers GIF | ✔ | | Multiple Sessions | ✔ | | Forward Messages | ✔ | | Receive message | ✔ | | insert user section | ✔ | | Send location | ✔ | | and much more | ✔ |

See more at WhatsApp methods

Installation

The first thing that you had to do is install the npm package :

npm i --save @wppconnect-team/wppconnect

See more at Getting Started

Development

Building WPPConnect is really simple, to build the entire project just run

> npm run build

Update checking

Whatsapp is in constant change. In order to tackle this issue, we suggest always keeping your Wppconnect package up-to-date.

The method/function names won't change, only their core algorithm. This way you won't have to makes changes in your code at every update. They will remain the same forever but might experience deprecation.

Maintainers

Maintainers are needed, I cannot keep with all the updates by myself. If you are interested please open a Pull Request.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Star History

Star History Chart

License

This file is part of WPPConnect.

WPPConnect is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

WPPConnect is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with WPPConnect. If not, see https://www.gnu.org/licenses/.

changelog

1.37.2 (2025-05-28)

  • fix: Upgrade whatsappversion (9c06639)

1.37.1 (2025-05-01)

  • fix(deps): update dependency @wppconnect/wa-js to ^3.17.2 (#2490) (95a6d9e), closes #2490

1.37.0 (2025-04-15)

  • build(deps-dev): update dependency @types/node to ^20.17.30 (#2481) (dcd6088), closes #2481

1.36.4 (2025-03-29)

  • fix(deps): update dependency @wppconnect/wa-js to ^3.17.0 (#2473) (597a6ac), closes #2473

1.36.3 (2025-03-27)

  • fix(deps): update dependency @wppconnect/wa-version to ^1.5.1244 (#2471) (b83713c), closes #2471

1.36.2 (2025-03-26)

1.36.1 (2025-03-21)

  • chore: update workflow for launch release (7dd3739)

1.36.0 (2025-03-21)

  • feat: Added client.onMessageEdit event (close #2092) (874f8c4), closes #2092

1.35.2 (2024-12-20)

  • fix(deps): update dependency @wppconnect/wa-js to ^3.16.0 (#2425) (28384fd), closes #2425

1.35.1 (2024-10-30)

  • fix: Upgrade whatsappVersion to 2.3000.10173x (2b609f5)

1.35.0 (2024-10-24)

  • fix(deps): update dependency @wppconnect/wa-version to ^1.5.557 (#2399) (4bc22a5), closes #2399

1.34.2 (2024-09-27)

  • build(deps): update dependency puppeteer to ^23.4.1 (#2349) (fe16137), closes #2349

1.34.1 (2024-09-09)

  • chore: rollback typedoc (077ff9b)

1.34.0 (2024-09-09)

  • fix(deps): update dependency @wppconnect/wa-js to ^3.10.1 (#2336) (cc29475), closes #2336

1.33.1 (2024-08-30)

  • fix: Fixed client.openChatAt (close #2293) (68e011c), closes #2293

1.33.0 (2024-08-05)

  • feat: Added client.closeChat function (close #2271) (#2290) (539e5d9), closes #2271 #2290

1.32.4 (2024-07-16)

  • fix(deps): update dependency @wppconnect/wa-js to ^3.6.0 (#2275) (4d56011), closes #2275

1.32.3 (2024-06-24)

  • chore: upgrade @wppconnect/wa-js (50775a8)

1.32.2 (2024-06-18)

  • chore: Remove unused deps (a600ce0)

1.32.1 (2024-06-17)

  • fix: Fixed emitting events (95e934d)

1.32.0 (2024-06-12)

  • fix: Improovment whatsappVersion to 2.3000.10139x (d246c58)

1.31.1 (2024-06-12)

Bug Fixes

  • Downgrade whatsappVersion to 2.2413.x (22ca707)

1.31.0 (2024-06-10)

Bug Fixes

  • deps: update dependency @wppconnect/wa-js to ^3.3.1 (#2205) (89c3298)

1.30.3 (2024-05-03)

Bug Fixes

  • deps: update dependency @wppconnect/wa-js to ^3.2.4 (#2168) (df59aec)

1.30.2 (2024-04-25)

Bug Fixes

  • Upgrade whatsappVersion (b8b1ec7)

1.30.1 (2024-03-11)

  • fix: Fixed login by qr code (5ebd5f5)

1.30.0 (2024-03-10)

  • fix(deps): update dependency @wppconnect/wa-js to v3 (#2103) (3f5a658), closes #2103

1.29.0 (2024-01-25)

  • [FIX] version whatsapp web (716cd97)

1.28.4 (2023-12-25)

  • fix: Remove unnecessary code for close instance (close #1835) (43f2a9b), closes #1835

1.28.3 (2023-11-15)

  • feat: Added client.getCommonGroups function (194c898)

1.28.2 (2023-11-04)

  • chore: Update release-it (4869dc8)

1.28.1 (2023-11-01)

  • fix : update version whatsappVersion 2.2347.x (6fe090a)

1.28.0 (2023-08-16)

1.27.3 (2023-06-14)

Bug Fixes

  • deps: update dependency @wppconnect/wa-version to ^1.2.49 (#1729) (bcb26ce)

1.27.2 (2023-06-05)

1.27.1 (2023-06-04)

Bug Fixes

  • Reverting to previous fix as a temporary workaround (#1718) (a0375b6)

1.27.0 (2023-06-02)

Bug Fixes

  • deps: update dependency @wppconnect/wa-version to ^1.2.44 (#1716) (a62cb18)

1.26.0 (2023-06-01)

1.25.0 (2023-05-30)

Bug Fixes

  • deps: update dependency @wppconnect/wa-version to ^1.2.42 (#1700) (1c07a4b)

1.24.0 (2023-04-29)

1.23.2 (2023-04-03)

1.23.1 (2023-03-25)

Bug Fixes

1.23.0 (2023-03-12)

Bug Fixes

  • Reduced the number of log for events (5b39646)

1.22.0 (2023-02-19)

Features

1.21.0 (2023-02-03)

Bug Fixes

  • deps: update dependency @wppconnect/wa-js to ^2.19.0 (#1531) (09626d0)

1.20.0 (2022-12-15)

Features

  • Added getVotes and getReactions functions (49bb58f)

1.19.2 (2022-12-11)

1.19.1 (2022-11-18)

Bug Fixes

1.19.0 (2022-11-02)

1.18.1 (2022-10-20)

Bug Fixes

  • Fixed "Checking phone is connected" without autoClose (ad63fb5)

1.18.0 (2022-10-18)

Features

1.17.1 (2022-10-10)

Bug Fixes

  • deps: update dependency @wppconnect/wa-js to ^2.13.1 (#1364) (ff92035)

1.17.0 (2022-09-17)

Bug Fixes

  • deps: update dependency @wppconnect/wa-version to ^1.1.154 (#1334) (daa94ef)

1.16.1 (2022-08-09)

1.16.0 (2022-08-05)

Bug Fixes

  • deps: update dependency @wppconnect/wa-js to ^2.10.0 (dc8133a)

1.15.0 (2022-07-20)

1.14.5 (2022-07-11)

1.14.4 (2022-06-20)

1.14.3 (2022-06-17)

Bug Fixes

  • deps: update dependency @wppconnect/wa-js to ^2.7.2 (#1181) (5208e62)

1.14.2 (2022-06-11)

Bug Fixes

  • Added filename for sendFile when is using path or URL (fix #1168) (5534fad)

1.14.1 (2022-06-08)

1.14.0 (2022-06-08)

Bug Fixes

  • deps: update dependency @wppconnect/wa-js to ^2.6.0 (27d5a52)

1.13.3 (2022-06-01)

Bug Fixes

  • Clear all token data when disconnected (fix #1147) (4abcfed)

1.13.2 (2022-05-28)

Bug Fixes

  • Migrate archiveChat and pinChat methods to WA-JS (cee7e1c)

1.13.1 (2022-05-10)

1.13.0 (2022-04-25)

Features

  • Improved chat state to keep alive and online (ba82005)

1.12.8 (2022-03-13)

Bug Fixes

  • Fixed stuck state after logout (bb9695a)

1.12.7 (2022-03-03)

Bug Fixes

  • Fixed onParticipantsChanged and onPresenceChanged function (fix #864, fix #911) (aff7f6c)

1.12.6 (2022-02-22)

Bug Fixes

  • Fixed getGroupMembersIds and getGroupMembers for large chats (fix #892) (9cc34a5)

1.12.5 (2022-02-06)

1.12.4 (2022-01-22)

Bug Fixes

  • Fixed getMessageById where the message is from status (fix #823) (ed57b97)

1.12.3 (2022-01-21)

Bug Fixes

  • Updated @wppconnect/wa-js to v1.1.9 (5074de1)

1.12.2 (2022-01-15)

1.12.1 (2022-01-14)

1.12.0 (2022-01-08)

Bug Fixes

1.11.1 (2021-12-09)

Bug Fixes

1.11.0 (2021-12-09)

Bug Fixes

  • Fixed initialization of onPresenceChanged (fix #704) (0470ea8)

1.10.3 (2021-11-18)

1.10.2 (2021-11-15)

Bug Fixes

  • Fixed call of createWid function (fix #647) (c381000)

1.10.1 (2021-11-11)

Features

  • Updated to latest version of WhatsApp (f6d01a3)

1.10.0 (2021-11-06)

1.9.4 (2021-10-21)

1.9.3 (2021-10-21)

Bug Fixes

1.9.2 (2021-10-12)

Features

1.9.1 (2021-10-02)

Features

  • Added option to use setProfilePic using base64 (close #505) (87f1841)

1.9.0 (2021-10-02)

1.8.14 (2021-09-19)

Bug Fixes

  • Allow to define chat type in sendMessageOptions (close #504) (bf76179)

1.8.13 (2021-08-19)

Bug Fixes

1.8.12 (2021-08-05)

1.8.11 (2021-08-04)

Features

  • Added setOnlinePresence function to define your presence (627d1a5)

1.8.10 (2021-07-31)

Bug Fixes

  • Corrigido erro "null to object" ao enviar mensagem (fix #378) (ec103b9)

1.8.9 (2021-07-27)

Bug Fixes

  • Corrigido a função de fixar conversas (pinChat) (fix #338) (f6bf1f3)

1.8.8 (2021-07-27)

Bug Fixes

1.8.7 (2021-07-26)

1.8.6 (2021-07-23)

1.8.5 (2021-07-20)

1.8.4 (2021-07-20)

Bug Fixes

  • Corrigido o envio de arquivos de tipos de áudio via URL (fix #329) (6e8b836)

1.8.3 (2021-07-14)

Bug Fixes

  • Corrigido disparos de onNotificationMessage e onParticipantsChanged ao iniciar (d421f7b)

1.8.2 (2021-07-14)

Features

  • Adicionado recurso de recusar ligação do WhatsApp (close #299) (e7ef0b6)

1.8.1 (2021-07-12)

Bug Fixes

  • Atualizado a versão estável do WhatsApp (08dabb2)

1.8.0 (2021-07-12)

Features

  • Estabilidade para evitar problemas na atualização do WhatsApp (97d26ab)

1.7.5 (2021-07-09)

Bug Fixes

  • Corrigido injeção de script para nova versão do WhatsApp Web (efd6fe7)

1.7.4 (2021-07-08)

Bug Fixes

  • Corrigido o disparo do evento onAddedToGroup (9e0fcbe)

1.7.3 (2021-07-02)

Bug Fixes

  • Corrigido função onAddedToGroup (fix #276) (f034d1a)
  • Envolvido todos erros para separar erro da LIB do puppeteer (68b933d)

Performance Improvements

  • Removido chat da serialização de mensagem para maior desempenho (#289) (69df15c)
  • Removido o quotedMsgObj da serialização de mensagem e adicionado quotedMsgId (#289) (3f6daaf)

1.7.2 (2021-07-01)

Features

  • Adicionado nova função getMessages (fix #282) (ee783e4)

1.7.1 (2021-06-22)

Bug Fixes

  • Corrigido a função sendLocation (fix #273) (e3dd987)

1.7.0 (2021-06-21)

Bug Fixes

  • Corrigido a função getProfilePicFromServer (#240) (b7061e5)
  • Corrigido e melhorado a função de onLiveLocation (fix #258) (6bc6d7e)

Features

1.6.0 (2021-06-02)

Bug Fixes

  • Fixed send message to non contact (c66b597)

1.5.2 (2021-05-24)

Bug Fixes

  • Fixed click to reload qr code, Update scrape-img-qr.ts (a2104e4) Thanks to @AlanMartines

1.5.1 (2021-05-21)

Bug Fixes

  • Fixed getGroupInviteLink function (fix #214) (597715b)

Features

  • Added revokeGroupInviteLink function; (50feb3c)

1.5.0 (2021-05-18)

Bug Fixes

Features

  • Added onPresenceChanged to listen presence change (4629699)
  • Added starMessage function to star/unstar messages (b83fcbb)

1.4.1 (2021-05-14)

Bug Fixes

1.4.0 (2021-05-08)

Bug Fixes

  • Fixed getAllMessagesInChat function when chat not found (2760f68)
  • Fixed onParticipantsChanged function (fix #171) (08975a0)
  • Improved speed of loadAndGetAllMessagesInChat function (fix #166) (7f1348a)

Features

  • Added getAllBroadcastList function (close #184) (351be03)
  • Added onNotificationMessage function for notif. msg. (#171) (32c395b)

1.3.6 (2021-05-04)

Bug Fixes

  • Fixed getAllUnreadMessages and getAllNewMessages (fix #170) (c45314f)

1.3.5 (2021-05-03)

Bug Fixes

  • Fixed deletion of tmp chrome user data dir on exit (8586505)
  • Fixed sendVideoAsGif from URL (0422a5b)

Features

  • Added sendGif method to send GIF in the chat (#112) (4ee590c)

1.3.4 (2021-04-30)

Bug Fixes

  • Fixed deletion of tmp chrome user data dir on exit (8586505)

1.3.3 (2021-04-28)

1.3.2 (2021-04-28)

Bug Fixes

  • Fixed message ID generator (0da9a62)
  • Fixed sendContact with custom name (#152) (47a51f0)

Features

  • Allow to define contact name in sendContactVcardList (#152) (474e5a0)

1.3.1 (2021-04-20)

Features

  • Added function to enable and disable temporary messages (5a9a289)
  • Added options to edit group description, subject and properties (07d155f)

1.3.0 (2021-04-16)

Bug Fixes

Features

  • Created tokenStore interface for session data management (a3a76c3)

1.2.6 (2021-04-12)

Bug Fixes

  • Fixed sendFile from URL (ff63fed)

1.2.5 (2021-04-07)

Bug Fixes

  • Fixed event dispose to stop listeners (#103) (0682c06)

Features

  • Added phoneWatchdog verification (6616fa2)

1.2.4 (2021-03-30)

Bug Fixes

  • Fixed inject token for authentication (c36466f)

1.2.3 (2021-03-29)

Bug Fixes

  • Fixed downloadMedia with new WhatsApp version (fix #76) (f61e118)

1.2.2 (2021-03-29)

Bug Fixes

  • Fixed logged token delete on disconnect (883d0d4)
  • Fixed statusFind callback (#fix 57) (cc0d3d6)

1.2.1 (2021-03-04)

Bug Fixes

  • Fixed send to status@broadcast (a0c8d20)

1.2.0 (2021-03-02)

Bug Fixes

  • Increased timeout WhatsApp page load (c1f8f03)

Features

1.1.0 (2021-02-27)

Bug Fixes

  • Fixed decryptFile function (c92597b)

Features

  • Allow pass browser/page in create method (#19) (a2902e8)

1.0.3 (2021-02-26)

Bug Fixes

  • Fixed "sender" field in message return (ca5f6ef)

chore

  • Deprecated create with argument option position based (020e71c)

BREAKING CHANGES

  • Deprecated create from argument in favor of CreateOptions

1.0.2 (2021-02-25)

Bug Fixes

  • WhatsApp Web v2.2106.5 compatibility (fa9d575)

1.0.1 (2021-02-24)

Bug Fixes

  • Fixed sendPtt from audio with codecs (2a8b476)

Features

  • Added sendPtt from file (ae38c8e)

1.0.0 (2021-02-24)