项目介绍:wa-automate-nodejs
项目概述
wa-automate-nodejs 是一个功能强大的 NodeJS 库,专为控制 WhatsApp Web 提供高级 API。通过此库,用户可以轻松地将 WhatsApp 帐户转换为一个强大的 API 工具,实现自动化的信息交流和管理功能。
安装与更新
要开始使用 wa-automate-nodejs,首先需要安装这个库。运行以下命令可以安装最新版本并保持库的更新:
> npm i --save @open-wa/wa-automate@latest
使用方式
wa-automate-nodejs 支持多种使用方式,包括 CLI(命令行界面)和自定义设置。
CLI 使用
如果想要快速将 WhatsApp 帐户转换为 API,可以使用 CLI。通过以下命令可以获取更多 CLI 的使用信息:
> npx @open-wa/wa-automate --help
自定义设置
用户可以根据自己的需求对配置进行自定义设置。以下是一个简单的 JavaScript 示例:
const wa = require('@open-wa/wa-automate');
wa.create({
sessionId: "COVID_HELPER",
multiDevice: true,
authTimeout: 60,
blockCrashLogs: true,
disableSpins: true,
headless: true,
hostNotificationLang: 'PT_BR',
logConsole: false,
popup: true,
qrTimeout: 0,
}).then(client => start(client));
function start(client) {
client.onMessage(async message => {
if (message.body === 'Hi') {
await client.sendText(message.from, '👋 Hello!');
}
});
}
执行 create()
函数后,@open-wa/wa-automate 将创建一个 WhatsApp Web 实例。如果尚未登录,将在终端输出二维码,扫描后即可开始使用。
多设备支持
当前,wa-automate-nodejs 正处于支持多设备的过渡阶段。一旦转型完成,缺省会开启多设备支持模式。现阶段,用户需要通过命令行标志 --multi-device
或自定义代码配置中的 multiDevice: true
来启用多设备支持。
主要功能
wa-automate-nodejs 提供了一系列有用的功能,包括但不限于:
- 接收信息:通过
onMessage
函数监听来信 - 发送文本消息:使用
sendText
- 获取联系人:通过
getContact
函数 - 获取聊天记录:使用
getAllChats
- 群组管理:包括获取群组、群组成员及管理参与者
- 发送多媒体:支持发送图片、音频、视频及文档等
- 实时位置监听:通过
onLiveLocation
函数 - 群組变化监听:通过
onParticipantsChanged
函数
这些功能让用户能够高效地管理和自动化 WhatsApp 中的操作。
运行演示
用户可以克隆项目仓库,使用 TypeScript 或 ts-node 运行示例演示。以下是示例命令:
> git clone https://github.com/open-wa/wa-automate-nodejs.git
> cd wa-automate-nodejs
> npm i
> npm install -g ts-node typescript
> cd demo
> ts-node index.ts
贡献与支持
欢迎提出 Pull Requests。如果用户希望做出重大更改,请先开一个 issue 以讨论建议内容。用户还可以通过多种方式支持或赞助项目的持续开发。
许可证与法律声明
wa-automate-nodejs 授权协议为《Hippocratic + Do Not Harm Version 1.0》。本项目为独立开发,与 WhatsApp 无任何关联,使用时需自行承担风险。由于此项目中包含加密软件,请确保遵循使用者所在国家的法律法规。
上述是 wa-automate-nodejs 项目的简介。在使用过程中,如果需要任何帮助或进一步的功能,可以参考项目文档或联系开发团队获取支持。