It is an unofficial Whatsapp API, which performs web scraping using puppeteer through the whatsapp-web.js library to automate whatsapp, making its resources available through a RESTful API.
| Feature | Status |
|---|---|
| Multi Device | ✅ |
| Send messages | ✅ |
| Send media (images/audio/documents) | ✅ |
| Send contact cards | ✅ |
| Send location | ✅ |
| Send buttons | ⏳ |
| Send lists | ⏳ (business accounts not supported) |
| Send messages in group | ✅ |
| Send media (images/audio/documents) in group | ✅ |
| Send contact cards in group | ✅ |
| Send location in group | ✅ |
| Get contact info | ✅ |
| Get profile pictures | ✅ |
Before starting, you will need to have the following tools installed on your machine: Git, Node.js, Yarn. Besides, it's good to have an editor to work with the code like VSCode
# Clone this repository
$ git clone https://github.com/andre-ols/whatsapp_api_nodejs.git
# access the project folder in the terminal/cmd
$ cd whatsapp_api_nodejs
# Install the dependencies and start the server:
$ yarn install
$ yarn start
# or
$ npm install
$ npm start
# Server Running Live on Port: 3000 - access <http://localhost:3000>-
Access the API through the browser: http://localhost:3000/auth to get QR code to scan.
-
After scanning the QR code, refresh the page to scan second QR code.
-
Done! ✅ You can now access the API Docs through http://localhost:3000/api-docs
The following tools were used in building the project:
André Oliveira
This project is under the license MIT.
Made with ❤️ by André Oliveira!