whatsapp-web.js README

The project's README from github.com/wwebjs/whatsapp-web.js. As one markdown file: README.md.

WWebJS Website

npm NPM Downloads GitHub contributors Depfu Discord server

About

whatsapp‑web.js is a powerful Node.js library that lets you interact with WhatsApp Web, making it easy to build a dynamic WhatsApp API with nearly all features of the web client. It uses Puppeteer to access WhatsApp Web’s internal functions and runs them in a managed browser instance to reduce the risk of being blocked.

Installation

Node.js v18.0.0 or higher, is required.

npm install whatsapp-web.js
yarn add whatsapp-web.js
pnpm add whatsapp-web.js

Having trouble installing? Take a peak at the Guide for more detailed instructions.

Example usage

const { Client } = require('whatsapp-web.js');
const qrcode = require('qrcode-terminal');

const client = new Client();

client.on('qr', (qr) => {
    qrcode.generate(qr, { small: true });
});

client.on('ready', () => {
    console.log('Client is ready!');
});

client.on('message', (msg) => {
    if (msg.body == '!ping') {
        msg.reply('pong');
    }
});

client.initialize();

Take a look at example.js for additional examples and use cases.
For more details on saving and restoring sessions, check out the Authentication Strategies.

Supported features

Feature Status
Multi Device ✅
Send messages ✅
Receive messages ✅
Send media (images/audio/documents) ✅
Send media (video) ✅ (requires Google Chrome)
Send stickers ✅
Receive media (images/audio/video/documents) ✅
Send contact cards ✅
Send location ✅
Send buttons ❌ (DEPRECATED)
Send lists ❌ (DEPRECATED)
Receive location ✅
Message replies ✅
Join groups by invite ✅
Get invite for group ✅
Modify group info (subject, description) ✅
Modify group settings (send messages, edit info) ✅
Add group participants ✅
Kick group participants ✅
Promote/demote group participants ✅
Mention users ✅
Mention groups ✅
Mute/unmute chats ✅
Block/unblock contacts ✅
Get contact info ✅
Get profile pictures ✅
Set user status message ✅
React to messages ✅
Create polls ✅
Channels ✅
Vote in polls ✅
Communities 🔜

Something missing? Make an issue and let us know!

Supporting the project

You can support the maintainer of this project through the links below:

Contributing

Feel free to open pull requests; we welcome contributions! However, for significant changes, it's best to open an issue beforehand. Make sure to review our contribution guidelines before creating a pull request. Before creating your own issue or pull request, always check to see if one already exists!

Disclaimer

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates. The official WhatsApp website can be found at whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners. Also it is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe.

License

Copyright 2019 Pedro S Lopez

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this project except in compliance with the License.
You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

whatsapp-web.js (wwebjs/whatsapp-web.js)

whatsapp-api
Searching Database…

22.7K ·GitHub
Whatsapp-web.js
What is this?It is a Node.js client library for WhatsApp: your code interacts with WhatsApp Web to build a WhatsApp API with nearly all features of the web client.
So it is not an official WhatsApp API — how does it actually work?It is a library you use in Node.js code, not a standalone app. Under the hood it drives the real WhatsApp Web client through Puppeteer, running in a managed browser instance.
How do I add it to my project?Install the package into a Node.js v18+ project with 'npm install whatsapp-web.js', then start from example.js; a Guide and full documentation are linked in the README.
What do I need installed before it will run?Node.js v18.0.0 or higher. The package pulls in Puppeteer plus media helpers like fluent-ffmpeg and node-webpmux, and sending video additionally requires Google Chrome.
How likely is my account to get banned for using it?The risk is real: this is an unofficial client and WhatsApp does not allow bots on its platform, so your number can be blocked and the project cannot guarantee safety.
Where does it run — do I need a specific OS?It is a Node.js library, so it runs wherever Node 18+ and Chrome/Chromium run — Windows, macOS or Linux. There is no mobile version: it controls a WhatsApp Web session, not the phone app.
Can I still send interactive buttons or list messages?No — both are marked ❌ (DEPRECATED) in the feature table, so stick to plain messages, media, stickers, polls and reactions.
Is anything special needed to send videos?Yes — the feature table notes that sending video media requires Google Chrome to be installed.
Does it support WhatsApp Communities?Not yet — Communities are marked as coming soon (🔜), while Channels, polls and regular group management already work.
What are similar projects?Baileys, OpenWA, go-whatsapp-web-multidevice, wechaty, openclaw, python-telegram-bot, ItChat, wxpy
Which topics is it in?whatsapp-api, whatsapp, bot, messaging, chat, browser-automation, chatbot, hacktoberfest, backend, npm, api, automation
Creator
wwebjs
Size
6.3 MB
Stars
22.7K
Updated
CommitSep 28Releasev1.34.7Apr 24
Age
7y
Commits · 90 Days