https://github.com/andre-ols/whatsapp_api_nodejs

NodeJS API Wrapper for WhatsApp
https://github.com/andre-ols/whatsapp_api_nodejs

bot nodejs nodejs-bot nodejs-wrapper whatsapp whatsapp-api whatsapp-bot whatsapp-chat whatsapp-web wrapper wrapper-api

Last synced: 3 months ago
JSON representation

NodeJS API Wrapper for WhatsApp

• Host: GitHub
• URL: https://github.com/andre-ols/whatsapp_api_nodejs
• Owner: andre-ols
• License: mit
• Created: 2022-04-01T19:45:45.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-09T19:18:46.000Z (over 3 years ago)
• Last Synced: 2025-03-25T19:12:38.300Z (4 months ago)
• Topics: bot, nodejs, nodejs-bot, nodejs-wrapper, whatsapp, whatsapp-api, whatsapp-bot, whatsapp-chat, whatsapp-web, wrapper, wrapper-api
• Language: JavaScript
• Homepage:
• Size: 37.1 KB
• Stars: 9
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Badge](https://img.shields.io/static/v1?label=NodeJs&message=16.14.2&color=339933&logo=node.js&link=https://nodejs.org/en/)

![Badge](https://img.shields.io/static/v1?label=Yarn&message=1.22.15&color=2C8EBB&logo=yarn&link=https://yarnpkg.com/)

![badge](https://img.shields.io/static/v1?label=license&message=MIT&color)

![badge](https://img.shields.io/github/last-commit/andre-ols/whatsapp_api_nodejs)

# Whatsapp API Nodejs



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.



 

	🚧  Whatsapp API Nodejs under construction...  🚧



### Supported features

| 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 | ✅ |

### How to Install

Before starting, you will need to have the following tools installed on your machine:

[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/), [Yarn](https://yarnpkg.com/). 

Besides, it's good to have an editor to work with the code like [VSCode](https://code.visualstudio.com/)

### 🎲 Running the API

```bash

# 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 

```

### How to use the API 🚀

- Access the API through the browser:  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 

### 🛠 Technologies Used

The following tools were used in building the project:

- [Node.js](https://nodejs.org/en/)

- [Yarn](https://yarnpkg.com/)

- [Express](https://expressjs.com/)

- [Whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js)

- [qrcode](https://www.npmjs.com/package/qrcode)

### Author

---



 


André Oliveira 







[![Linkedin Badge](https://img.shields.io/badge/-André-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/andr%C3%A9-oliveira-silva-3496a2106/)](https://www.linkedin.com/in/andr%C3%A9-oliveira-silva-3496a2106/) 

[![Gmail Badge](https://img.shields.io/badge/[email protected]?style=flat-square&logo=Gmail&logoColor=white&link=mailto:[email protected])](mailto:[email protected])

## License

This project is under the license [MIT](./LICENSE).

Made with ❤️ by André Oliveira!