Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vasani-arpit/WBOT

A simple Web based BOT for WhatsApp™ in NodeJS 😜. Working as of 📅 Feb 4th, 2024
https://github.com/vasani-arpit/WBOT

bot cli command-line-tool hacktoberfest hacktoberfest-accepted linux macos nodejs puppeteer wbot whatsapp whatsapp-bot whatsapp-web windows

Last synced: 14 days ago
JSON representation

A simple Web based BOT for WhatsApp™ in NodeJS 😜. Working as of 📅 Feb 4th, 2024

Awesome Lists containing this project

README 

        



# WBOT 



 [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal]][paypal-donations] 



> A simple Nodejs BOT for whatsapp web



Preview •

Features •

Downloads •

How to? •

Technologies Used •

Why? •

Goals •

deploy •

FAQ



## 🔍 Preview 



### Quick preview

![Screenshot gif](https://user-images.githubusercontent.com/6497827/58411958-1dcc8000-8093-11e9-8aeb-5747efe10266.gif)



## ⚡ Features 



* 🎨 Highly customizable json

* 💯 Totally Free for personal use

* 🔒 Complete Privacy. Your data stays with you always

* 💻 Download media files automatically

* 👥 Multiple instances 



## ⬇ Downloads ⬇



macOS | Windows | Linux

-----------------| ---| ---|

[Download Latest Release](https://github.com/vasani-arpit/WBOT/releases/latest/download/WBOT-mac.zip) | [Download Latest Release](https://github.com/vasani-arpit/WBOT/releases/latest/download/WBOT-win.zip) | [Download Latest Release](https://github.com/vasani-arpit/WBOT/releases/latest/download/WBOT-linux.zip)



## Supported Platforms

Following platforms are supported by Wbot:



**macOS:**

The minimum version supported is macOS 10.9.



**Windows:**

Windows 7 and later are supported.



**Linux:**



- Ubuntu 12.04 and later

- Fedora 21

- Debian 8



## How to start the BOT?



### STEPS



After downloading, extract the zip file and open the bot.json file and in the third line change the value of "headless" from true to false. Now, navigate to the location of the WBOT folder in your terminal. There will be a file named ```wbot-*``` . Run it and you should be good to go.



For Linux you need to provide executable permission before you execute the binary. 

Run the command - 

```

chmod +x wbot-linux && wbot-linux

```



Note: On Linux you need a running display server (X11 or Wayland).

If you run Linux on a headless server or want to run chmomium without visible display try ```xvfb-run wbot-linux```.



*I haven't tested Mac and Linux binaries. If you find any issues using them feel free to raise one from [here](https://github.com/vasani-arpit/WBOT/issues/new)*



### Configurations 



Basic configuration is in ```bot.json``` file like replying to ```Hi, hello and happy birthday```. You can change this config file as per your need. Keep in mind that you need to restart the wbot to see the effects of your changes. Make sure the JSON is valid. Use VSCode or [jsonlint](https://jsonlint.com/) to validate the JSON.



### bot.json 



**appconfig**



This is where all the application related (node application behavior and such things) config will stay. Will add more in future.



- **headless:** whether to start chrome as headless or not. this is regarding #4. Apparently, Whatsapp doesn't allow headless instances.

- **isGroupReply:** whether to send replies in group or not. If set to false, Bot will not reply if message received in group chat.



- **webhook:** A URL which will be called for every message with payload data. This can be useful if you want to do other operation over messages in your server. For example: server code take a look [here](https://github.com/vasani-arpit/WBOT/blob/master/docs/Webhook-example.md)



- **downloadMedia:** Whether to download incoming message media or not. 



- **replyUnreadMsg:** If there are pending unread messages which bot hasn't replied to then by making this flag true, bot will respond to those messages. Keep in mind that bot will not be able to mark those messages as read/seen. Please open the chat manually in the phone to mark that chat as read otherwise bot will reply to it at every start. 



- **CustomInjectionFolder** relative path of the folder from current directory which has JS file which needs to be injected in the browser. for example if you have something like following 

```

└── WBOT  /

    ├── bot.json

    ├── github-two.png

    ├── github.png

    ├── wbot-win.exe

    └── injection/

        ├── index.js

        └── utils.js

```



then you need to set the value of this property as ```./injection```



**bot**



An array of objects. Properties of Object are self explanatory. 



- **Contains:** If message has one of that word anywhere in the message

- **exact:** If message is exactly as one of the messages form array



- **Response:** If any of the above conditions becomes true then corresponding response string or [spintax](https://spintaxtool.appspot.com/) will be sent as message to the user or group. There are two variable: `name` and `phoneNumber` which you can use to create custom message for sender. Sample message with variable is in `bot.json`.



- **file:** Name of the file (from current directory) which you want to send along with response.



- **afterSeconds:** Number of seconds bot should wait before sending a reply. 

- **Webhook:** You can call your webhook on certain keywords as well instead of calling it on every message. 

- **responseAsCaption:** This will be applied in case you want to reply with image. If true then response block will be sent as a caption of the image. If false then response block will be shared as separate text message.



**Blocked**



Array of numbers with county code to which this bot will not reply to.



**Allowed**



If not empty, only messages from numbers in this list will be replied to.



**noMatch**



Default reply message or [spintax](https://spintaxtool.appspot.com/) when no exact match found in WBOT



**smartreply** *(This feature is under maintenance at the moment.)*



An object which contains suggestions and it's configs.



- **suggestions** An Array of suggestions

- **clicktosend** Whether to send or just write message when user clicks on suggestion



here is how that looks



![smart reply gif](https://user-images.githubusercontent.com/6497827/58412366-f1653380-8093-11e9-8427-1ca19235faed.gif)



## Run the latest code from Github



**This is only recommended for advanced 'node.js' users or for development purpose.**



Open a Terminal and create a new directory in your home directory, e.g. 'node' and goto there.

Now download and run the latest code from github by:



```

git clone https://github.com/vasani-arpit/WBOT.git

cd WBOT

npm install

node src/index.js

```



If you run Linux on a headless server or want to run chromium without visible display try ```xvfb-run wbot-linux```.



## Known bugs

Sometimes, closing the `node` server directly does not clear browser cache. Next time when the bot is started, it runs into errors due to which smart reply is not setup correctly. A temporary fix to this is to clear `node` cache.



```java-script 

npm cache clean

```



## 💻 Technologies

* [Node](https://nodejs.org/en/)

* [puppeteer](https://github.com/GoogleChrome/puppeteer)



## Why?



The main reason I decided to build this is that I needed a simple tool to reply to my "happy birthday" messages. I know it is kind of blunt and rude but it would take me 2-3 days to reply to all and by that time that moment would be gone. I needed a good solution to this problem. I really don't need a full-fledged AI-BOT or BOT with NLU (or some other acronym). I believe there are many people who also have such needs.



## Goals

With that in mind, I know that WBOT would need to satisfy these criteria:



* 🚀 Fast!!!

* 👍 Friendly CLI UX

* 🔒 Does not touch user’s data

* 💰 Free! for personal use



**If you think WBOT delivers these, let me know by putting a star ⭐ on this project**



## Deploy



If you want to run wbot 24x7 then running your computer on for 24x7 is not a good idea. You can host it on linux cloud. You can use something like Digital Ocean. Instructions on how to do that is avalible at below image link. 



[![Deploy to DO](https://raw.githubusercontent.com/open-wa/wa-automate-deploy-heroku/main/assets/do_deploy.png)](./DEPLOY.md)



## FAQ



* **Is this app built with NodeJS?**



  Yes, it's built with [NodeJS](https://nodejs.org/en/). Please see the [Technologies](#-technologies) section for more info.



* **What boilerplate did you use?**



  None. The idea was to get a better understanding of how things work together, But I do take a cue from other projects.



* **What npm modules did you use?**



  - [Ora](https://www.npmjs.com/package/ora) for spinner 

  - [cli-progress](https://www.npmjs.com/package/cli-progress) for download progress bar in terminal

  - [qrcode-terminal](https://www.npmjs.com/package/qrcode-terminal) to generate QRCode in terminal 

  - [mime](https://www.npmjs.com/package/mime) detect mime file sent

  - [mel-spintax](https://www.npmjs.com/package/mel-spintax) to support spintax



* **Apart from development, What else do you do?**



  I do motion design and UI/UX development.



* **Are you available for hire?**



  I have a full-time job as a software developer at technobrains.net and at mindtechconsultancy.com. I am available as a freelance consultant during my spare time please let me know what you have in mind.



* **How do I contact you?**



  If you find an issue, please report it here. For everything else, please drop me a line at [email protected]



* **Do you have any other projects?**



  I thought you'd never ask. Yes, I do. [SMA](https://github.com/vasani-arpit/Social-Media-Automation) is one of them.



[badge_paypal]: https://user-images.githubusercontent.com/6497827/53698092-42032280-3dfe-11e9-8054-1597c62d344e.png

[badge_patreon]: https://user-images.githubusercontent.com/6497827/53698102-4af3f400-3dfe-11e9-9749-4104ceb6ea3c.png

[badge_amazon]: https://user-images.githubusercontent.com/6497827/53698105-51826b80-3dfe-11e9-9e63-b14ad6ad7c19.png

[twitter_logo]: https://user-images.githubusercontent.com/6497827/57843958-c30e6b00-77ec-11e9-97bd-dfbc800f96a9.png

[telegram_logo]: https://user-images.githubusercontent.com/6497827/57844175-2ac4b600-77ed-11e9-8488-f2d45efa7497.png

[gmail_logo]: https://user-images.githubusercontent.com/6497827/62424751-c1b85480-b6f0-11e9-97de-096c0a980829.png

[DO_logo]: https://raw.githubusercontent.com/open-wa/wa-automate-deploy-heroku/main/assets/do_deploy.png



[patreon]: https://www.patreon.com/arpit_vasani

[amazon]: https://amzn.in/iCUjhKZ

[paypal-donations]: https://www.paypal.me/arpitvasani

[twitter]: https://twitter.com/ArpitVasani

[telegram]: https://t.me/Arpit_Vasani

[gmail]: mailto:[email protected]?subject=Regarding%20Wbot&body=Hi



[digitalOceanLink]: https://m.do.co/c/dd173aa6d77d



## 📃 Legal

This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by WhatsApp or any of its affiliates or subsidiaries. This is an independent and unofficial software. Use at your own risk. **Commercial use of this code/repo is strictly prohibited.**



## 👋 Contact Me 👋



[![Contact me on twitter][twitter_logo]][twitter]

[![Contact me on telegram][telegram_logo]][telegram]

[![Mail me][gmail_logo]][gmail]