关于

通过 WhatsApp Web 浏览器应用程序连接的 WhatsApp API 客户端

该库的工作原理是启动 WhatsApp Web 浏览器应用程序并使用 Puppeteer 对其进行管理，以创建 WhatsApp Web 实例，从而降低被阻止的风险。 WhatsApp API 客户端通过 WhatsApp Web 浏览器应用程序进行连接，访问其内部功能。这使您可以访问 WhatsApp Web 上几乎所有可用的功能，从而实现与任何其他 Node.js 应用程序类似的动态处理。

重要的

使用此方法不保证您不会被阻止。 WhatsApp 不允许机器人或非官方客户端使用其平台，因此这不应被视为完全安全。

链接

网站
指南（来源） （正在进行中）
文档（来源）
WWebJS 不和谐
GitHub
新项目管理

安装

该模块现已在 npm 上提供！ npm i whatsapp-web.js

笔记

需要节点v18+ 。

升级节点的快速步骤

视窗

手动的

只需从官方节点网站获取最新的 LTS 即可。

新项目管理

sudo npm install - g n
sudo n stable

巧克力

choco install nodejs - lts

温盖特

winget install OpenJS.NodeJS.LTS

乌班图 / 德班

curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - && 
sudo apt-get install -y nodejs

用法示例

 const { Client } = require ( 'whatsapp-web.js' ) ;

const client = new Client ( ) ;

client . on ( 'qr' , ( qr ) => {
    // Generate and scan this code with your phone
    console . log ( 'QR RECEIVED' , qr ) ;
} ) ;

client . on ( 'ready' , ( ) => {
    console . log ( 'Client is ready!' ) ;
} ) ;

client . on ( 'message' , msg => {
    if ( msg . body == '!ping' ) {
        msg . reply ( 'pong' ) ;
    }
} ) ;

client . initialize ( ) ;

查看 example.js 以获取具有其他用例的另一个示例。
有关保存和恢复会话的更多详细信息，请浏览提供的身份验证策略。

支持的功能

特征	地位
多设备	✅
发送消息	✅
接收消息	✅
发送媒体（图像/音频/文档）	✅
发送媒体（视频）	✅（需要谷歌浏览器）
发送贴纸	✅
接收媒体（图像/音频/视频/文档）	✅
发送名片	✅
发送位置	✅
发送按钮	❌（已弃用）
发送列表	❌（已弃用）
接收位置	✅
留言回复	✅
通过邀请加入群组	✅
获得团体邀请	✅
修改群组信息（主题、描述）	✅
修改群组设置（发送消息、编辑信息）	✅
添加群组参与者	✅
踢出群组参与者	✅
提升/降级群组参与者	✅
提及用户	✅
提及群组	✅
静音/取消静音聊天	✅
阻止/取消阻止联系人	✅
获取联系方式	✅
获取个人资料图片	✅
设置用户状态消息	✅
对消息作出反应	✅
创建投票	✅
在民意调查中投票
社区
渠道

缺少什么吗？提出问题并让我们知道！

贡献

请随意打开拉取请求；我们欢迎贡献！但是，对于重大更改，最好提前提出问题。在创建拉取请求之前，请务必查看我们的贡献指南。在创建自己的问题或拉取请求之前，请务必检查是否已经存在！

支持项目

您可以通过以下链接支持该项目的维护者

通过 GitHub 赞助商提供支持
通过 PayPal 支持
注册 DigitalOcean 并在注册时获得 200 美元积分（推荐）

免责声明

本项目与 WhatsApp 或其任何子公司或附属公司不隶属、关联、授权、认可或以任何方式正式关联。 WhatsApp 官方网站可以在whatsapp.com 上找到。 “WhatsApp”以及相关名称、标记、徽章和图像是其各自所有者的注册商标。此外，使用此方法也不保证您不会被阻止。 WhatsApp 不允许机器人或非官方客户端使用其平台，因此这不应被视为完全安全。