mirror of
https://github.com/cheveguerra/ws-api-node.git
synced 2026-04-17 19:36:23 +00:00
119 lines
4.0 KiB
Markdown
119 lines
4.0 KiB
Markdown
|
||
# whatsapp-node-api
|
||
|
||
[](https://www.patreon.com/pranavms) [](https://www.paypal.me/pranavms1)
|
||
|
||
|
||
> A simple NodeJS Wrapper for [whatsapp-web.js by pedroslopez](https://github.com/pedroslopez/whatsapp-web.js)
|
||
|
||
|
||
|
||
• [Technologies Used](https://github.com/pranavms13/whatsapp-node-api#technologies) • [Why?](https://github.com/pranavms13/whatsapp-node-api#why) • [Goals](https://github.com/pranavms13/whatsapp-node-api#goals) • [FAQ](https://github.com/pranavms13/whatsapp-node-api#faq)
|
||
|
||
|
||
|
||
## [](https://github.com/pranavms13/whatsapp-node-api#technologies)💻 Technologies
|
||
|
||
|
||
|
||
- [NodeJS](https://nodejs.org/en/)
|
||
|
||
- [whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js)
|
||
|
||
- [puppeteer](https://github.com/GoogleChrome/puppeteer)
|
||
|
||
|
||
## [API Doc](https://github.com/pranavms13/whatsapp-node-api/blob/master/APIDOC.MD)
|
||
|
||
|
||
## [](https://github.com/pranavms13/whatsapp-node-api#why)Why?
|
||
|
||
|
||
|
||
The main reason I decided to build this is that there are many developers who want to play around with Whatsapp API and use them in personal applications before getting/purchasing a Whatsapp Business Account API officially from Whatsapp.
|
||
|
||
|
||
|
||
## [](https://github.com/pranavms13/whatsapp-node-api#goals)Goals
|
||
|
||
|
||
|
||
- 🚀 Fast!!!
|
||
|
||
- 🔒 Does not touch user’s data
|
||
|
||
- 💰 Free! for personal use
|
||
|
||
|
||
|
||
If you think whatsapp-node-api delivers these, let me know by putting a star ⭐ on this project.
|
||
|
||
|
||
|
||
## [](https://github.com/pranavms13/whatsapp-node-api#faq)FAQ
|
||
|
||
|
||
|
||
- **Is this app built with NodeJS?**
|
||
|
||
Yes, it's built with [NodeJS](https://nodejs.org/en/). Please see the [Technologies](https://github.com/pranavms13/whatsapp-node-api#technologies) section for more info.
|
||
|
||
- **What boilerplate did you use?**
|
||
|
||
None. The idea was to get a better understanding of how things work together, But I do take a cue from other projects.
|
||
|
||
- **What npm modules did you use?**
|
||
|
||
- [express](https://github.com/expressjs/express) for API Server
|
||
|
||
- [body-parser](https://github.com/expressjs/body-parser) Node.js body parser middleware
|
||
|
||
- [fs](https://www.npmjs.com/package/fs) To read session.json
|
||
|
||
- [whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js) A WhatsApp API client that connects through the WhatsApp Web browser app
|
||
|
||
|
||
|
||
- **How do I contact you?**
|
||
|
||
If you find an issue, please report it here. For everything else, please drop me a line at [pranavms13@yahoo.com](mailto:pranavms13@yahoo.com)
|
||
|
||
- **Do you have any other projects?**
|
||
|
||
I thought you'd never ask. Yes, I do.
|
||
|
||
[https://github.com/pranavms13](https://github.com/pranavms13)
|
||
|
||
|
||
|
||
## [](https://github.com/pranavms13/whatsapp-node-api#legal)📃 Legal
|
||
|
||
|
||
|
||
This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by WhatsApp or any of its affiliates or subsidiaries. This is an independent and unofficial software. Use at your own risk. **Commercial use of this code/repo is strictly prohibited.**
|
||
|
||
|
||
|
||
## PR's are welcome
|
||
|
||
|
||
|
||
|
||
|
||
## [](https://github.com/pranavms13/whatsapp-node-api#donate)Donate
|
||
|
||
|
||
|
||
You can support the maintainer of this project through donation :
|
||
|
||
|
||
|
||
[](https://www.paypal.me/pranavms1/) **or** [UPI Donate](https://pranavms.ml/donate)
|
||
|
||
|
||
|
||
## [](https://github.com/pranavms13/whatsapp-node-api#contact-me)👋 Contact Me 👋
|
||
|
||
|
||
|
||
[ ](http://t.me/pranavms13) [](mailto:pranavms13@yahoo.com?subject=Regarding%20Wbot&body=Hi) |