[!WARNING]
通过访问此页面，您即明确同意服务条款（请在此处阅读）

安装与更新

使用以下命令首次安装库，并保持库为最新版本。

> npm i --save @open-wa/wa-automate@latest

使用方法

CLI

想立即将您的 WhatsApp 账号转换为 API 吗？现在可以通过 CLI 实现。更多详情请参阅 简易 API

> npx @open-wa/wa-automate --help

自定义设置

在此处了解所有可能的配置选项：ConfigObject

const wa = require('@open-wa/wa-automate');

wa.create({
  sessionId: "COVID_HELPER",
  multiDevice: true, // 必须启用多设备支持
  authTimeout: 60, // 只等待 60 秒即可与主机账号设备建立连接
  blockCrashLogs: true,
  disableSpins: true,
  headless: true,
  hostNotificationLang: 'PT_BR',
  logConsole: false,
  popup: true,
  qrTimeout: 0, // 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 实例。如果您尚未登录，它将在 终端 中显示一个二维码。用手机扫描该二维码，您就可以开始使用了！

@open-wa/wa-automate 会记住会话，因此无需每次都重新认证

多设备支持

目前我们正处于一个特殊的过渡期，有些人被迫采用多设备功能（MD）。一旦过渡完成，库的默认设置将是开启多设备支持。在此之前，您需要通过使用 --multi-device 标志（配合 CLI）或在配置中设置 multiDevice: true（通过自定义代码），来显式地启用多设备功能。

最新变更

由于 WhatsApp 不断更新，建议始终使用最新版本的 @open-wa/wa-automate。

函数列表

函数	参考文档
接收消息	onMessage
自动刷新二维码	autoRefresh
发送文本	sendText
获取联系人	getContact
获取聊天记录	getAllChats
获取群组	getAllGroups
获取群组成员	getGroupMembersId
发送联系人	sendContact
发送图片（image）	sendImage
发送媒体（音频、文档）	sendFile
发送媒体（视频）	Send Videos
发送贴纸	sendStickerfromUrl
解密媒体（图片、音频、文档）	Decrypt Media
捕获二维码	Capturing QR Code
多会话	Multiple Sessions
最后上线时间	getLastSeen
是否在线	isChatOnline
📍 发送位置	sendLocation
模拟“正在输入”	simulateTyping
发送 GIF！	sendVideoAsGif
发送 Giphy！	sendGiphy
转发消息	forwardMessages
监听已读回执	onAck
监听实时位置	onLiveLocation
群组成员变更	onParticipantsChanged
创建群组	Create Group
添加、移除、提升、降级成员	Manage Participants

在此处查看所有可用函数。

运行演示

您可以克隆此仓库并运行演示，但需要使用 TypeScript 和 ts-node：

> 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

贡献

欢迎提交 Pull Request。对于重大更改，请先打开一个议题讨论您希望进行的修改。

支持

如果您需要付费支持、咨询，或只是想支持/赞助本项目的持续开发，可以通过以下方式：

| 描述 | 链接 | |- |:-:| | 获取许可证密钥 | 获取许可证密钥 | 捐款或预订1小时咨询 | | 按分钟计费的咨询服务 | | 雇佣我！ |

许可证

Hippocratic + Do Not Harm Version 1.0

法律声明

本代码与 WhatsApp 或其任何关联公司、子公司均无任何隶属关系，也未获得其授权、维护、赞助或认可。这是一款独立且非官方的软件。请自行承担使用风险。

加密通知

本发行版包含加密软件。您目前居住的国家或地区可能对加密软件的进口、持有、使用和/或再出口到其他国家/地区有限制。在使用任何加密软件之前，请务必查阅您所在国家或地区的相关法律、法规和政策，了解是否允许进口、持有、使用及再出口此类软件。更多信息请参阅 http://www.wassenaar.org/。

美国商务部工业与安全局（BIS）已将该软件归类为出口商品控制编号（ECCN）5D002.C.1，该编号涵盖使用或执行基于非对称算法的加密功能的信息安全软件。根据本发行版的形式和分发方式，其出口可适用许可证豁免 ENC 技术软件无限制（TSU）条款（参见 BIS 出口管理条例第 740.13 节），适用于目标代码和源代码。

wa-automate-nodejs 快速上手指南

wa-automate-nodejs 是一个高级 Node.js 库，提供用于控制 WhatsApp Web 的 API。本指南将帮助你快速在本地环境中部署并运行第一个 WhatsApp 自动化脚本。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统: Windows, macOS 或 Linux
• Node.js: 建议安装最新的 LTS 版本 (v14+)
• npm: 随 Node.js 自动安装
• WhatsApp 账号: 一个可用于扫描二维码登录的有效手机号

注意：该库依赖 Chromium 浏览器内核，首次运行时会自动下载相关二进制文件，请确保网络连接畅通。国内用户若遇到下载缓慢问题，可尝试配置全局代理或寻找国内 Chromium 镜像源。

安装步骤

使用 npm 安装最新版本的库。为了获得更稳定的下载速度，建议先切换至国内镜像源（如淘宝镜像）。

1. (可选) 配置国内镜像源

npm config set registry https://registry.npmmirror.com

2. 安装依赖 在你的项目目录下执行以下命令：

npm i --save @open-wa/wa-automate@latest

基本使用

以下是最简单的代码示例，展示如何初始化客户端、扫描二维码登录并监听消息。

1. 创建脚本文件 新建一个名为 index.js 的文件，并填入以下代码：

const wa = require('@open-wa/wa-automate');

wa.create({
  sessionId: "MY_BOT",
  multiDevice: true, // 必须设置为 true 以启用多设备支持
  authTimeout: 60,   // 等待主机设备连接的超时时间（秒）
  headless: true,    // 是否在后台运行浏览器（生产环境建议为 true）
  qrTimeout: 0,      // 0 表示无限期等待扫描二维码
}).then(client => start(client));

function start(client) {
  console.log("机器人已启动，等待消息...");
  
  client.onMessage(async message => {
    // 当收到消息时触发
    if (message.body === 'Hi') {
      await client.sendText(message.from, '👋 Hello! 这是一个自动回复测试。');
    }
  });
}

2. 运行脚本 在终端中执行：

node index.js

3. 扫码登录

• 脚本运行后，终端会打印出一个 QR 二维码。
• 打开手机上的 WhatsApp，进入 设置 (Settings) > 已连接设备 (Linked Devices) > 连接设备 (Link a Device)。
• 扫描终端中的二维码。
• 扫描成功后，会话将被保存。下次运行脚本时无需再次扫码，除非你清除了缓存或会话过期。

现在，当你向该账号发送 "Hi" 时，机器人将自动回复。更多高级功能（如发送图片、群组管理等）请参考官方文档。