This is a WhatsApp bot built with Express.js that connects through the WhatsApp Web browser app and uses the WhatsApp Web JS client library for the WhatsApp Web API.
- Send text messages to multiple individuals or groups simultaneously via API
- Send file messages with or without captions to multiple individuals or groups via API
- Send images as base64 to multiple individuals or groups via API
- Check WhatsApp Group IDs
- Test response with
!pingcommand - Check logs with
!logscommand - Delete messages by message ID with
!deleteMessage,yourmessageidcommand (You can check messageId in the logs)
-
Clone the repository:
git clone https://github.com/nestorzamili/whatsapp-web.js.git
-
Install the dependencies:
npm install
-
Create a
.envfile in the root directory with the following variables:PORT=3000 API_KEY=your_api_key_here # Only required for remote authentication (AWS S3) AWS_REGION=your_aws_region AWS_ACCESS_KEY_ID=your_aws_access_key AWS_SECRET_ACCESS_KEY=your_aws_secret_key AWS_BUCKET_NAME=your_s3_bucket_name AWS_REMOTE_DATA_PATH=your_remote_path -
Start the bot:
npm start
The bot will display a QR code in the terminal. Scan this QR code with your phone to log in to WhatsApp Web and start using the bot.
The bot offers two authentication strategies:
- Local Authentication: Uses
app.jsto store WhatsApp session data locally - Remote Authentication: Uses
remoteAuth.jsto store session data in AWS S3
To use Remote Authentication with AWS S3, make sure you have properly configured the AWS environment variables in your .env file.
Generate your API key using Node.js in your terminal:
echo "samunu_$(openssl rand -hex 32)"Copy the generated key to the API_KEY variable in your .env file.
All API endpoints require authentication via the x-api-key header.
GET http://localhost:3000/get-group-id
| Header | Type | Description |
|---|---|---|
x-api-key |
string |
Required. Your API key |
Request Body:
{
"groupName": "Name of the group."
}POST http://localhost:3000/send-plaintext
| Header | Type | Description |
|---|---|---|
x-api-key |
string |
Required. Your API key |
Content-Type |
application/json |
Required. |
Request Body:
{
"message": "Your message here",
"id": "123456789@g.us,987654321@c.us"
}The id parameter can contain multiple IDs separated by commas without spaces.
POST http://localhost:3000/send-file
| Header | Type | Description |
|---|---|---|
x-api-key |
string |
Required. Your API key |
Form Data:
id(string): Required. Recipient ID(s), separate multiple with commacaption(string): Optional caption textattachment(file): Required. File to send
POST http://localhost:3000/send-base64-image
| Header | Type | Description |
|---|---|---|
x-api-key |
string |
Required. Your API key |
Content-Type |
application/json |
Required. |
Request Body:
{
"id": "123456789@g.us",
"caption": "Optional image caption",
"images": [
{
"mimetype": "image/jpeg",
"data": "base64encodedstring...",
"filename": "image1.jpg"
},
{
"mimetype": "image/png",
"data": "base64encodedstring...",
"filename": "image2.png"
}
]
}The bot responds to the following commands in WhatsApp chats:
!ping: Tests if the bot is active; it will respond with "pong"!logs: Shows the last 10 lines from the log file!deleteMessage,messageID: Deletes a message with the specified ID (only works for messages sent by the bot)
For more details about the WhatsApp Web JS library, visit: https://docs.wwebjs.dev/
Contributions are always welcome! Please fork this repository and submit pull requests.
This project is licensed under the Apache-2.0 License. See the LICENSE file for more details.