Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-wa/wa-automate-nodejs
💬 🤖 The most reliable tool for chatbots with advanced features. Be sure to 🌟 this repository for updates!
https://github.com/open-wa/wa-automate-nodejs
api chatbots framework nodejs typescript
Last synced: about 2 months ago
JSON representation
💬 🤖 The most reliable tool for chatbots with advanced features. Be sure to 🌟 this repository for updates!
- Host: GitHub
- URL: https://github.com/open-wa/wa-automate-nodejs
- Owner: open-wa
- License: other
- Created: 2019-08-15T00:25:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T13:16:44.000Z (4 months ago)
- Last Synced: 2024-05-16T14:34:03.534Z (4 months ago)
- Topics: api, chatbots, framework, nodejs, typescript
- Language: TypeScript
- Homepage: https://docs.openwa.dev/
- Size: 167 MB
- Stars: 3,028
- Watchers: 105
- Forks: 590
- Open Issues: 115
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome - open-wa/wa-automate-nodejs - 💬 🤖 The most reliable tool for chatbots with advanced features. Be sure to 🌟 this repository for updates! (TypeScript)
README
> [!WARNING]
> By visiting this page you [explicitly agree to the Terms of Service (read here)](https://github.com/open-wa/wa-automate-nodejs/blob/master/tos.md)
# wa-automate-nodejs
> wa-automate-nodejs is the most advanced NodeJS library which provides a high-level API to control WA.
>
>
[](https://techforpalestine.org/learn-more)
[](https://www.npmjs.com/package/@open-wa/wa-automate)
[](https://www.npmjs.com/package/@open-wa/wa-automate)
[](http://isitmaintained.com/project/open-wa/wa-automate-nodejs "Average time to resolve an issue")
[](http://isitmaintained.com/project/open-wa/wa-automate-nodejs "Percentage of issues still open")
Key Features •
Getting Started •
Easy API •
Documentation •
Get a License Key •
Support
## Installation and Updating
Use this command to install the library for the first time and to keep the library up to date.
```bash
> npm i --save @open-wa/wa-automate@latest
```
## Usage
## CLI
Want to convert your WA account to an API instantly? You can now with the CLI. For more details see [Easy API](https://docs.openwa.dev/pages/Getting%20Started/quick-run.html)
```bash
> npx @open-wa/wa-automate --help
```
## Custom Setup
Learn more about all possible configuration options here: [ConfigObject](https://docs.openwa.dev/interfaces/api_model_config.ConfigObject.html)
```javascript
const wa = require('@open-wa/wa-automate');
wa.create({
sessionId: "COVID_HELPER",
multiDevice: true, //required to enable multiDevice support
authTimeout: 60, //wait only 60 seconds to get a connection with the host account device
blockCrashLogs: true,
disableSpins: true,
headless: true,
hostNotificationLang: 'PT_BR',
logConsole: false,
popup: true,
qrTimeout: 0, //0 means it will wait forever for you to scan the qr code
}).then(client => start(client));
function start(client) {
client.onMessage(async message => {
if (message.body === 'Hi') {
await client.sendText(message.from, '👋 Hello!');
}
});
}
```
###### After executing `create()` function, **@open-wa/wa-automate** will create an instance of WA web. If you are not logged in, it will print a QR code in the [terminal](https://i.imgur.com/g8QvERI.png). Scan it with your phone and you are ready to go!
###### @open-wa/wa-automate will remember the session so there is no need to authenticate every time
## Multi Device Support
We're currently in a weird transitionary period where some people are being forced to adopt Multi Device (MD). Once the transition is complete, the library default will be to turn on MD support. For now, you have to set it yourself explicitly either by using the `--multi-device` flag (with the [CLI](#CLI)) or setting `multiDevice: true` in your config (with your custom code)
### Latest Changes
With the constant updates from WA. It is advisable to always use the latest version of `@open-wa/wa-automate`.
### Functions list
| Function | Reference |
| --------------------------------- | ----------- |
| Receive message | [onMessage](https://docs.openwa.dev/classes/api_Client.Client.html#onMessage)
| Automatic QR Refresh | [autoRefresh](https://docs.openwa.dev/classes/api_Client.Client.html#autoRefresh)
| Send text | [sendText](https://docs.openwa.dev/classes/api_Client.Client.html#sendText)
| Get contacts | [getContact](https://docs.openwa.dev/classes/api_Client.Client.html#getContact)
| Get chats | [getAllChats](https://docs.openwa.dev/classes/api_Client.Client.html#getAllChats)
| Get groups | [getAllGroups](https://docs.openwa.dev/classes/api_Client.Client.html#getAllGroups)
| Get group members | [getGroupMembersId](https://docs.openwa.dev/classes/api_Client.Client.html#getGroupMembersId)
| Send contact | [sendContact](https://docs.openwa.dev/classes/api_Client.Client.html#sendContact)
| Send Images (image) | [sendImage](https://docs.openwa.dev/classes/api_Client.Client.html#sendImage)
| Send media (audio, doc) | [sendFile](https://docs.openwa.dev/classes/api_Client.Client.html#sendFile)
| Send media (video) | [Send Videos](https://docs.openwa.dev/pages/How%20to/send-files/send-videos.html)
| Send stickers | [sendStickerfromUrl](https://docs.openwa.dev/classes/api_Client.Client.html#sendStickerFromuUrl)
| Decrypt media (image, audio, doc) | [Decrypt Media](https://docs.openwa.dev/pages/How%20to/decrypt-media.html)
| Capturing QR Code | [Capturing QR Code](https://docs.openwa.dev/pages/The%20Client/launch-events/capture-qr.html)
| Multiple Sessions | [Multiple Sessions](https://docs.openwa.dev/pages/The%20Client/the-client/multiple-sessions.html)
| Last seen | [getLastSeen](https://docs.openwa.dev/classes/api_Client.Client.html#getLastSeen)
| isOnline | [isChatOnline](https://docs.openwa.dev/classes/api_Client.Client.html#isChatOnline)
| 📍 Send Location | [sendLocation](https://docs.openwa.dev/classes/api_Client.Client.html#sendLocation)
| Simulated '...typing' | [simulateTyping](https://docs.openwa.dev/classes/api_Client.Client.html#simulateTyping)
| Send GIFs! | [sendVideoAsGif](https://docs.openwa.dev/classes/api_Client.Client.html#sendVideoAsGif)
| Send Giphy! | [sendGiphy](https://docs.openwa.dev/classes/api_Client.Client.html#sendGiphy)
| Forward Messages | [forwardMessages](https://docs.openwa.dev/classes/api_Client.Client.html#forwardMessages)
| Listen to Read Receipts | [onAck](https://docs.openwa.dev/classes/api_Client.Client.html#onAck)
| Listen to Live Locations | [onLiveLocation](https://docs.openwa.dev/classes/api_Client.Client.html#onLiveLocation)
| Group participant changes | [onParticipantsChanged](https://docs.openwa.dev/classes/api_Client.Client.html#onParticipantsChanged)
| Create Groups | [Create Group](https://docs.openwa.dev/pages/How%20to/groups.html#create-a-group)
| add, remove, promote, demote participants | [Manage Participants](https://docs.openwa.dev/pages/How%20to/groups/manage-participants.html)
[Checkout all the available functions here.](https://docs.openwa.dev/classes/api_Client.Client.html)
## Running the demo
You can clone this repo and run the demo, but you will need to use typescript/ts-node:
```bash
> git clone https://github.com/open-wa/wa-automate-nodejs.git
> cd wa-automate-nodejs
> npm i
> npm i -g ts-node typescript
> cd demo
> ts-node index.ts
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Support
If you need paid support, consulting, or just want support/sponsor the ongoing development of this project, you can in the following ways:
|Description | Link |
|- |:-:|
| Get a License key | Get a License key
| Donate or Book 1 hour consult | [![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
| Per-minute consulting | 
| Hire me! | [![Consulting Request][consult-shield]][consult]
## License
[Hippocratic + Do Not Harm Version 1.0](https://github.com/open-wa/wa-automate-nodejs/blob/master/LICENSE.md)
## Legal
This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by WA or any of its affiliates or subsidiaries. This is an independent and unofficial software. Use at your own risk.
## Cryptography Notice
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See [http://www.wassenaar.org/](http://www.wassenaar.org/) for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/smashah
[consult-shield]: https://img.shields.io/badge/Require%20Paid%20Support%20or%20Consulting%3F-Click%20Here-blue?style=for-the-badge&logo=paypal
[consult]: mailto:[email protected]?subject=WhatsApp%20Consulting