Repository files navigation

REST API wrapper for thewhatsapp-web.js library, providing an easy-to-use interface to interact with the WhatsApp Web platform.It is designed to be used as a docker container, scalable, secure, and easy to integrate with other non-NodeJs projects.

This project is a work in progress: star it, create issues, features or pull requests ❣️

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.

1. Quick Start with Docker

2. Features

3. Run Locally

4. Testing

5. Documentation

6. Deploy to Production

7. Contributing

8. License

9. Star History

1. Clone the repository:

git clone https://github.com/chrishubert/whatsapp-api.gitcd whatsapp-api

3. Run the Docker Compose:

docker-compose pull&& docker-compose up

4. Visithttp://localhost:3000/session/start/ABCD

5. Scan the QR on your console using WhatsApp mobile app -> Linked Device -> Link a Device (it may take time to setup the session)

6. Visithttp://localhost:3000/client/getContacts/ABCD

7. EXTRA: Look at all the callbacks data in./session/message_log.txt

1. API and Callbacks

3. Handle multiple client sessions (session data saved locally), identified by unique id

4. All endpoints may be secured by a global API key

5. On server start, all existing sessions are restored

6. Set messages automatically as read

7. Disable any of the callbacks

1. Clone the repository:

git clone https://github.com/chrishubert/whatsapp-api.gitcd whatsapp-api

2. Install the dependencies:

npm install

3. Copy the.env.example file to.env and update the required environment variables:

cp .env.example .env

4. Run the application:

npm run start

5. Access the API athttp://localhost:3000

Run the test suite with the following command:

npm runtest

API documentation can be found in theswagger.json file. See this file directly intoSwagger Editor or any other OpenAPI-compatible tool to view and interact with the API documentation.

This documentation is straightforward if you are familiar with whatsapp-web.js library (https://docs.wwebjs.dev/)If you are still confused - open an issue and I'll improve it.

Also, there is an option to run the documentation endpoint locally by setting theENABLE_SWAGGER_ENDPOINT environment variable. Restart the service and go to/api-docs endpoint to see it.

By default, all callback events are delivered to the webhook defined with theBASE_WEBHOOK_URL environment variable.This can be overridden by setting the*_WEBHOOK_URL environment variable, where* is your sessionId.For example, if you have the sessionId defined asDEMO, the environment variable must beDEMO_WEBHOOK_URL.

By setting theDISABLED_CALLBACKS environment variable you can specify what events you arenot willing to receive on your webhook.

In order to validate a new WhatsApp Web instance you need to scan the QR code using your mobile phone. Official documentation can be found at (https://faq.whatsapp.com/1079327266110265/?cms_platform=android) page. The service itself delivers the QR code content as a webhook event or you can use the REST endpoints (/session/qr/:sessionId or/session/qr/:sessionId/image to get the QR code as a png image).

• Load the docker image in docker-compose, or your Kubernetes environment
• Disable theENABLE_LOCAL_CALLBACK_EXAMPLE environment variable
• Set theAPI_KEY environment variable to protect the REST endpoints
• Run periodically the/api/terminateInactiveSessions endpoint to prevent useless sessions to take up space and resources(only in case you are not in control of the sessions)

Please readCONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates. The official WhatsApp website can be found athttps://whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.

This project is licensed under the MIT License - see theLICENSE.md file for details.