Simple WhatsApp bot from unofficial WhatsApp API, built in NodeJS & TypeScript, using Gemini & ChatGPT APIs for completion, with many cool features. You can interact with the bot using voice messages, and it will transcribe and respond. 🤖
In development mode, your bot prefix will be automatically set to !. Meanning that you can use !help to get the list of commands instead of /help.
| Feature | Description | Example |
|---|---|---|
| Voice Chat | Chat with AI and expect a audio/text response from the bot | Just send an audio message |
| AI Completion with Gemini AI | Sends a message to the AI | /chat [text] |
| AI Completion with ChatGPT | Sends a message to the AI | /gpt [text] |
| Video Download from social media | Download file from social media | Just send the video link or /get <url> |
| Memes | Get random meme | /meme |
| Jokes | Get random joke | /joke |
| Help | Get help | /help |
| Ping | Ping the bot | /ping |
| Language Translation | Translate text to the specified language | /translate [language-code] [text] |
| Weather | Get current weather for a city | /meteo <city> |
- From DockerHub image for a Quick Test
docker pull yaasiinayeva/whatsbot:latest
docker run -d -p 3000:3000 yaasiinayeva/whatsbot- From the Github Code
- After cloning the project make sure to setup your environnment variables from the
.env.examplefile
cp .env.example .env- Then Build your container and start your project
docker compose build ; docker compose up -dA QR code will be generated for you to scan. Go to localhost:3000 Kindly scan it with your whatsapp app and you're all set! 🎉
Important
Running locally requires you to do more configuration. You have to install redis-server on your machine. This project is based on whatsappweb.js which uses Pupperteer. It requires a brower driver to work. You have to install Chrome or Chromium on your machine. Make sure the environment variables are set in the .env file before starting the server. The PUPPETEER_EXECUTABLE_PATH should be set to your chrome/chromium browser path.
npm install
cp .env.example .env
npm run devA QR code will be generated for you to scan. Go to localhost:3000 Kindly scan it with your whatsapp app and you're all set! 🎉
You can change the configurations in src/configs/app.config.ts
For third-party services used in the bot, kindly get the API keys and set them correctly. These are the one used in the bot, skipping them could lead to limitations :
- Gemini : AI for text completion
- ChatGPT : ChatGPT for text completion
- Open Weather API : Provides weather information
- Speechify : Text-to-Speech tool used in this project
- AssemblyAI : Speech to text tool used in this project
Warning
It is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, especially when it is used to spam people. So this shouldn't be considered totally safe.
If you'd like to contribute, please read the Contributing Guide