Skip to content

YogaSakti/whatsapp-web.js

 
 

Repository files navigation

npm Depfu WhatsApp_Web 0.4.1296

whatsapp-web.js

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.

Installation

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

Please note that Node v8+ is required due to Puppeteer.

Example usage

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.

Supported features

Feature Status
Send messages
Receive messages
Send media (images/audio/documents)
Send media (video) ✅ (requires google chrome)
Send stickers pending
Receive media (images/audio/video/documents)
Send contact cards pending
Send location
Receive location
Message replies
Join groups by invite
Get invite for group
Modify group info (subject, description)
Add group participants
Kick group participants
Promote/demote group participants
Mention users
Get contact info
Get profile pictures
Set user status message

Something missing? Make an issue and let us know!

Links

Contributing

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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%