🚧 This project is under construction and not ready for use yet. 🚧
This project is a simple restfull API to send messages to whatsapp using the baileys library as a base for the API service with multi device support.
clone this repository
git clone
install dependencies
npm install
copy the envs/.env.example file to envs/.env and fill the variables
cp envs/.env.exemple envs/.env.development
run the project
npm run dev
- Generate RSA Keys Run the following command to create RSA keys:
node create-rsa.js
- Generate Token Execute the command below to generate a token:
node generate-token.js
- Copy the generated token from the console and use it in your requests.
Example:
curl -X GET \
https://api.example.com/data \
-H 'Authorization: Bearer <token>'
This project uses a Dockerized development environment. Below are the details about the configured development environment:
update envs/.env.development
file with the docker variables
cp envs/.env.exemple envs/.env.development
run the project
docker-compose up -d
Open an interactive terminal:
docker exec -it container-name /bin/bash
You can now run commands as if you were in the local environment. For instance:
npm install
npm run dev
All routes are documented in Postman
Check the contributing file for more details.
Check the structure file for more details.
This project is under the MIT license. See the LICENSE file for more details.
This project is an independent initiative and is not affiliated, authorized, maintained, sponsored, or endorsed by WhatsApp (WA) or any of its affiliates or subsidiaries.
The official WhatsApp website can be accessed at https://whatsapp.com. The terms "WhatsApp," as well as any names, trademarks, badges, and associated images, are trademarks of their respective owners.
This software is an unofficial implementation. Its use is at the user's own risk. We recommend not using it for spam or any activity that violates the terms of service of WhatsApp.
The development team assumes no responsibility for any damages or issues resulting from the use of this software.
Thank you for your understanding.