A WhatsApp API client that connects through the WhatsApp Web browser app

It uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocked.

NOTE: I can't guarantee you will not be blocked by using this method, although it has worked for me. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe.

The module is now available on npm! npm i whatsapp-web.js

Please note that Node v12+ is required.

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

const client = new Client();

client.on('qr', (qr) => {
    // Generate and scan this code with your phone
    console.log('QR RECEIVED', qr);
});

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 another example with more use cases.

You could also connect to any previously existing browser instance:

const client = new Client({ 
    puppeteer: {
        browserWSEndpoint: `ws:https://localhost:3000`
    }
});

1. Installing a browser using browserless:

docker run \
  --rm \
  -p 3000:3000 \
  -e "MAX_CONCURRENT_SESSIONS=1" \
  browserless/chrome:latest

Reference: https://docs.browserless.io/docs/docker-quickstart.html

2. Running a browser with websocket remote debugging enabled:

chrome.exe --remote-debugging-port=9222

After that check the following webpage and check https://127.0.0.1:9220/json and get the webSocketDebuggerUrl

Something missing? Make an issue and let us know!

• Reference
• Guide (work in progress)
• GitHub
• npm

Pull requests are welcome! If you see something you'd like to add, please do. For drastic changes, please open an issue first.

You can support the maintainer of this project through the link below

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 https://whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.

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.