介绍
wechat.plus 是一款基于 wechaty-puppet-padplus 的 Node.js 库,它提供了简洁的 API,可以帮助开发者使用 wechaty-puppet-padplus 更便捷地实现基于微信的聊天机器人、微信自动回复等功能。
安装
在安装 wechat.plus 前,需要先安装 wechaty 和 wechaty-puppet-padplus:
npm install wechaty wechaty-puppet-padplus
安装完成后,可以直接在命令行中安装 wechat.plus:
npm install wechat.plus
使用
初始化 wechat.plus
首先,需要引入 wechat.plus 并创建一个实例,同时指定使用的 wechaty-puppet-padplus 的 token,例如:
const { WechatPlus } = require('wechat.plus') const bot = new WechatPlus('your-token-here')
配置 wechat.plus
在初始化了 wechat.plus 后,我们需要调用 config
方法对 wechat.plus 进行配置。例如:
bot.config({ autoSave: true, })
参数 autoSave
指定是否自动保存聊天记录,默认为 false
。
登录微信
wechat.plus 已经封装了登录微信的流程,只需要调用 login
方法即可,例如:
bot .login() .then(() => console.log('login succeed!')) .catch(error => console.log('login failed!', error))
在登录成功后,可以监听 scan
事件,此时微信需要扫描二维码:
bot.on('scan', (qrcode, status) => { console.log(`Scan QR Code to login: ${status}\nhttps://api.qrserver.com/v1/create-qr-code/?data=${encodeURIComponent(qrcode)}`) })
当扫描成功后,可以监听 login
事件,此时可以执行相关操作了:
bot.on('login', user => console.log(`${user.name()} logged in`))
监听消息
wechat.plus 提供了多种监听消息的方法:
bot.on('message', message => console.log(`received message: ${message.text()} from ${message.from().name()}`)) bot.on('friendship', friendship => console.log(`new friendship: ${friendship.contact().name()}`)) bot.on('room-join', (room, inviteeList) => console.log(`room join: ${room.topic()} invited ${inviteeList.map(c => c.name()).join(', ')}`))
发送消息
通过 wechat.plus 发送消息也很简单。例如:
const contact = await bot.Contact.find({ name: '刘备' }) await contact.say('hello, 刘备!')
其中,find
方法可以根据联系人的名称、微信号、备注名称等信息查找联系人信息。
其他 API
wechat.plus 还提供了大量的 API 方法,例如搜索联系人、获取联系人列表、创建群组、修改群组名称等。想了解更多详情,请参考官方文档。
示例代码
以下是一个简单的示例代码,内容涵盖了 wechat.plus 的初始化、登录微信、监听消息和发送消息等功能:
-- -------------------- ---- ------- ----- - ---------- - - ---------------------- ----- --- - --- ----------------------------- ------------ --------- ----- -- -------------- -------- ------- -- - ----------------- -- ---- -- ------ ------------------------------------------------------------------------------------------- -- --------------- ---- -- --------------------------- ------ ----- ----------------- ----- ------- -- - -- --------------- --- -------- - ----- ------- - -------------- ----- ------------------- ----- - -- --- -------- -------- -- ------------------ ----------- ------------ -- ------------------ --------- -------
结论
wechat.plus 是一款非常实用的 Node.js 库,它封装了 wechaty-puppet-padplus 的功能,提供了简洁的 API,能够帮助你更快速地开发微信机器人、微信自动回复等功能,祝你使用愉快!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006710a8dd3466f61ffe057