时间:2023-05-20 10:20:01 | 来源:网站运营
时间:2023-05-20 10:20:01 来源:网站运营
Wechaty | 企业级微信机器人助手:import { Wechaty } from 'wechaty'Wechaty.instance().on('scan', qrcode => console.log('扫码登录:' + qrcode)).on('login', user => console.log('登录成功:' + user)).on('message', message => console.log('收到消息:' + message)).on('friendship', friendship => console.log('收到好友请求:' + friendship)).on('room-invite', invitation => console.log('收到入群邀请:' + invitation)).start()
├── config│ └── index.js // 配置文件├── package.json├── service│ ├── bot-service│ │ ├── error-service.js│ │ ├── friendship-service.js│ │ ├── heartbeat-service.js│ │ ├── login-service│ │ │ ├── function-service.js│ │ │ └── index.js│ │ ├── logout-service.js│ │ ├── message-service│ │ │ ├── function-service.js│ │ │ └── index.js│ │ ├── ready-service│ │ │ ├── function-service.js│ │ │ └── index.js│ │ ├── room-invite-service.js│ │ ├── room-join-service.js│ │ ├── room-leave-service.js│ │ ├── room-topic-service.js│ │ └── scan-service│ │ └── index.js│ ├── common-service│ │ ├── chatbot-service.js│ │ ├── ding-service.js│ │ └── oss-service.js│ └── redis-service│ └── index.js├── src│ └── main.js // 入口├── store│ └── index.js // 全局存储对象├── utils│ ├── oss.js // 阿里云oss认证│ └── redis.js // redis认证登录└── yarn.lock
src/main.jsconst { Wechaty } = require('wechaty') // 机器人木偶const { onScan } = require("../service/bot-service/scan-service") // 当机器人需要扫码登陆的时候会触发这个事件。const { onLogin } = require("../service/bot-service/login-service") // 当机器人成功登陆后,会触发事件,并会在事件中传递当前登陆机器人的信息const { onLogout } = require("../service/bot-service/logout-service") // 当机器人检测到登出的时候,会触发事件,并会在事件中传递机器人的信息。const { onReady } = require("../service/bot-service/ready-service") // 当所有数据加载完成后,会触发这个事件。在wechaty-puppet-padchat 中,它意味着已经加载完成Contact 和Room 的信息。const { onMessage } = require("../service/bot-service/message-service") // 当机器人收到消息的时候会触发这个事件。const { onRoomInvite } = require("../service/bot-service/room-invite-service") // 当收到群邀请的时候,会触发这个事件。const { onRoomTopic } = require("../service/bot-service/room-topic-service") // 当有人修改群名称的时候会触发这个事件。const { onRoomJoin } = require("../service/bot-service/room-join-service") // 当有人进入微信群的时候会触发这个事件。机器人主动进入某个微信群,那个样会触发这个事件。const { onRoomleave } = require("../service/bot-service/room-leave-service") // 当机器人把群里某个用户移出群聊的时候会触发这个时间。用户主动退群是无法检测到的。const { onFriendship } = require("../service/bot-service/friendship-service") // 当有人给机器人发好友请求的时候会触发这个事件。const { onHeartbeat } = require('../service/bot-service/heartbeat-service') // 获取机器人的心跳。const { onError } = require('../service/bot-service/error-service') // 当机器人内部出错的时候会触发error 事件。const { wechatyToken } = require('../config/index') // 机器人tokenconst { globalData } = require('../store/index') // 全局对象globalData.bot = new Wechaty({ puppet: 'wechaty-puppet-hostie', puppetOptions: { token: wechatyToken }});globalData.bot .on('scan', onScan) .on('login', onLogin) .on('logout', onLogout) .on('ready', onReady) .on('message', onMessage) .on('room-invite', onRoomInvite) .on('room-topic', onRoomTopic) .on('room-join', onRoomJoin) .on('room-leave', onRoomleave) .on('friendship', onFriendship) .on('heartbeat', onHeartbeat) .on('error', onError) .start()
const QrcodeTerminal = require('qrcode-terminal');const { ScanStatus } = require('wechaty-puppet')/** * @method onScan 当机器人需要扫码登陆的时候会触发这个事件。 建议你安装 qrcode-terminal(运行 npm install qrcode-terminal) 这个包,这样你可以在命令行中直接看到二维码。 * @param {*} qrcode * @param {*} status */const onScan = async (qrcode, status) => { try { if (status === ScanStatus.Waiting) { console.log(`======================== 二维码状态:${status} ========================/n/n`) QrcodeTerminal.generate(qrcode, { small: true }) } } catch (error) { console.log('onScan', error) }}module.exports = { onScan }
const { notificationLoginInformation } = require('../../common-service/ding-service')const { updateBotInfo } = require('./function-service')const { globalData } = require('../../../store/index')/** * @method onLogin 当机器人成功登陆后,会触发事件,并会在事件中传递当前登陆机器人的信息 * @param {*} botInfo */const onLogin = async botInfo => { try { console.log('======================== onLogin ========================/n/n') console.log(`机器人信息:${JSON.stringify(botInfo)}/n/n`) console.log(` // // // // // ##DDDDDDDDDDDDDDDDDDDDDD## ## DDDDDDDDDDDDDDDDDDDD ## ## DDDDDDDDDDDDDDDDDDDD ## ## hh hh ## ## ## ## ## ## ## ## ## ### ## #### ## ## hh // // hh ## ## ## ## ## ## ## ## ## ## hh // // hh ## ## ## ## ## ## ## ## ## ## hh hh ## ## ## ## ## ## ## ## ## ## ## hh wwww hh ## ## ## ## ## ## ## ## #### ## hh hh ## ## ## ## ## ## ## ## ## ## ## ### ## ## ### ## MMMMMMMMMMMMMMMMMMMM ## ##MMMMMMMMMMMMMMMMMMMMMM## 微信机器人名为: [${botInfo.payload.name}] 已经扫码登录成功了。/n/n `) // 全局存储机器人信息 globalData.botPayload = botInfo.payload // 更新机器人列表 updateBotInfo() // 机器人登录登出提醒/通知钉钉接口 notificationLoginInformation(true) } catch (error) { console.log(`onLogin: ${error}`) }}module.exports = { onLogin }
— 机器人异常退出 当node服务异常终端,或者手机上退出机器人登录后会触发onLogout事件,同样钉钉群内通知信息,并且销毁程序中运行的一些定时器等const { notificationLoginInformation } = require('../common-service//ding-service')const { globalData } = require('../../store/index')/** * @method onLogout 当机器人检测到登出的时候,会触发事件,并会在事件中传递机器人的信息。 * @param {*} botInfo */const onLogout = async botInfo => { try { console.log('======================== onLogout ========================') console.log(`当bot检测到注销时,将与当前登录用户的联系人发出注销。`) // 全局存储机器人信息 globalData.botPayload = botInfo.payload const { updateRoomInfoTimer, chatbotSayQueueTimer } = globalData // 机器人退出清空定时器 if (updateRoomInfoTimer) { clearTimeout(updateRoomInfoTimer) } if (chatbotSayQueueTimer) { clearInterval(chatbotSayQueueTimer) } // 机器人登录登出提醒/通知钉钉接口 notificationLoginInformation(false) } catch (error) { console.log(`error in onLogout:${error}`) }}module.exports = { onLogout }
const dayjs = require('dayjs');const { say } = require('../../common-service/chatbot-service')const { isCanSay, roomIdentifyVin, rooImageIdentifyVin, contactIdentifyVin, contactImageIdentifyVin, messageProcessing, storageRoomMessage, storageContactMessage,} = require('./function-service')const { roomMessageFeedback, contactMessageFeedback} = require('../../common-service/ding-service')const { globalData } = require('../../../store/index');const { Message } = require('wechaty');/** * @method onMessage 当机器人收到消息的时候会触发这个事件。 * @param {*} message */const onMessage = async message => { try { console.log('======================== onMessage ========================/n/n') // 机器人信息 const { botPayload } = globalData // 获取发送消息的联系人 const contact = message.from() // 获取消息所在的微信群,如果这条消息不在微信群中,会返回null const room = message.room() // 查看这条消息是否为机器人发送的 const isSelf = message.self() // 处理消息内容 const text = await messageProcessing(message) // console.log(`======================== 处理消息后内容为:${text} ========================/n/n`) // 消息为空不处理 if (!text) return // 消息详情 const messagePayload = message.payload // console.log(`======================== 消息详情:${JSON.stringify(messagePayload)} ========================/n/n`) // 消息联系人详情 const contactPayload = contact.payload // console.log(`======================== 消息联系人详情:${JSON.stringify(contactPayload)} ========================/n/n`) // 群消息 if (room) { console.log(`======================== 群聊消息 ========================/n/n`) // 房间详情 const roomPayload = room.payload // console.log(`======================== 房间详情:${JSON.stringify(roomPayload)} ========================/n/n`) console.log(`消息时间:${dayjs(messagePayload.timestamp).format('YYYY-MM-DD HH:mm:ss')}/n/n群聊名称:${roomPayload.topic}/n/n微信名称:${contactPayload.name}/n/n微信类型:${contactPayload.type}/n/n备注昵称:${contactPayload.alias}/n/n消息内容:${text}/n/n消息类型:${messagePayload.type}/n/n`); // 存储消息内容 const storeMessage = { category: 'room', // 消息类别,room为群聊消息, contact为个人消息。 isSelf: isSelf, // 是否自己发送的消息 messageId: messagePayload.id, // 消息id messageToId: messagePayload.toId, // 消息接收者id messageType: messagePayload.type, // 消息类型 messageText: text, // 消息内容 messageTimestamp: messagePayload.timestamp, // 消息时间戳 messageTime: dayjs(messagePayload.timestamp).format('YYYY-MM-DD HH:mm:ss'), // 消息时间 roomOwnerId: roomPayload.ownerId, // 群聊群主id roomTopic: roomPayload.topic, // 群聊名称 roomId: roomPayload.id, // 群聊名称 contactId: contactPayload.id, // 消息发送者id contactName: contactPayload.name, // 消息发送者昵称 contactType: contactPayload.type, // 消息发送者类型 contactAvatar: contactPayload.avatar, // 消息发送者头像 contactAlias: contactPayload.alias, // 消息发送者备注 } // redis中存储群聊消息内容 storageRoomMessage(roomPayload, storeMessage) // 消息是机器人自己发的 或者 消息发送到wechaty接收间隔大于半个小时 if (isSelf || message.age() > 1800) return // 判断当前机器人在群中是否可以说话 if (!await isCanSay(roomPayload)) return // 有人@我 const isMentionSelf = await message.mentionSelf() // 如果有人@我 if (isMentionSelf) { console.log('this message were mentioned me! [You were mentioned] tip ([有人@我]的提示)') // 获取消息内容,拿到整个消息文本,去掉 @名字 const sendText = text.replace("@" + botPayload.name, "") if (sendText == '图片') { // 通过不同的关键字进行业务处理逻辑 say({ messageType: 6, sender: room, messageInfo: { fromUrl: 'https://wework.qpic.cn/wwhead/nMl9ssowtibVGyrmvBiaibzDqfABIxIv4ic0FyQRxgQVpUIaqlePxrDW8L2qPB3WnHSZclgQ1D1QhDs/0' } }) return } if (sendText == '分享') { // 通过不同的关键字进行业务处理逻辑 say({ messageType: 14, sender: room, messageInfo: { urlLink: { description: 'WeChat Bot SDK for Individual Account, Powered by TypeScript, Docker, and Love', thumbnailUrl: 'https://avatars0.githubusercontent.com/u/25162437?s=200&v=4', title: 'Welcome to Wechaty', url: 'https://github.com/wechaty/wechaty', } } }) return } if (sendText == '名片') { say({ messageType: 3, sender: room, messageInfo: { contactCard: 'contactId' } }) return } if (sendText == '小程序') { say({ messageType: 9, sender: room, messageInfo: { miniProgram: { appid: 'xxxxx', title: '我正在使用Authing认证身份,你也来试试吧', pagePath: 'pages/home/home.html', description: '身份管家', thumbUrl: '30590201000452305002010002041092541302033d0af802040b30feb602045df0c2c5042b777875706c6f61645f31373533353339353230344063686174726f6f6d3131355f313537363035393538390204010400030201000400', thumbKey: '42f8609e62817ae45cf7d8fefb532e83', } } }) return } // 群里正常说话 } else { // 重构机器人功能测试群 if (roomPayload.id !== 'R:10696051737544800') { console.log(`======================== 不是测试群消息,不处理群内业务逻辑 ========================/n/n`) return } if (/^[a-zA-Z0-9]{17}$/.test(text)) { // 群聊识别vin反馈 roomIdentifyVin(room, contact, message, text) return } // 群内消息以[弱]开头的信息为反馈信息。反馈给后台 if (text.indexOf('[弱]') === 0) { // 群消息反馈 roomMessageFeedback(room, contact, text) return } // 如果是图片,则图片解析vin if (messagePayload.type === Message.Type.Image) { // 群聊图片识别vin反馈 rooImageIdentifyVin(room, contact, message) } } // 私聊消息 } else { console.log(`======================== 私聊消息 ========================/n/n`) console.log(`消息时间:${dayjs(messagePayload.timestamp).format('YYYY-MM-DD HH:mm:ss')}/n/n微信名称:${contactPayload.name}/n/n微信类型:${contactPayload.type}/n/n备注昵称:${contactPayload.alias}/n/n消息内容:${text}/n/n消息类型:${messagePayload.type}/n/n`); // 存储消息内容 const storeMessage = { category: 'contact', // 消息类别,room为群聊消息, contact为个人消息。 isSelf: isSelf, // 是否自己发送的消息 messageId: messagePayload.id, // 消息id messageToId: messagePayload.toId, // 消息接收者id messageType: messagePayload.type, // 消息类型 messageText: text, // 消息内容 messageTimestamp: messagePayload.timestamp, // 消息时间戳 messageTime: dayjs(messagePayload.timestamp).format('YYYY-MM-DD HH:mm:ss'), // 消息时间 contactId: contactPayload.id, // 消息发送者id contactName: contactPayload.name, // 消息发送者昵称 contactType: contactPayload.type, // 消息发送者类型 contactAvatar: contactPayload.avatar, // 消息发送者头像 contactAlias: contactPayload.alias, // 消息发送者备注 } // redis中存储私聊消息内容 storageContactMessage(contact, storeMessage) // 消息是机器人自己发的 或者 消息发送到wechaty接收间隔大于半个小时 if (isSelf || message.age() > 1800) return if (/^[a-zA-Z0-9]{17}$/.test(text)) { // 私聊识别vin反馈 contactIdentifyVin(contact, message, text) return } // 私聊消息以[弱]开头的信息为反馈信息。反馈给后台 if (text.indexOf('[弱]') === 0) { // 私聊消息反馈 contactMessageFeedback(contact, text) return } // 如果是图片,则图片解析vin if (messagePayload.type === Message.Type.Image) { // 私聊图片解析vin反馈 contactImageIdentifyVin(contact, message) } } } catch (error) { console.log(`onMessage:${error}`) }}module.exports = { onMessage }
至于其他的一些生命周期以及钩子函数。大家可以参考文档做出属于自己的应用机器人const { MiniProgram, UrlLink, FileBox } = require('wechaty')const dayjs = require('dayjs');const { DelayQueueExector } = require('rx-queue');const { redisHexists, redisHset, redisHget, redisSet, redisLpush } = require('../redis-service/index')const { globalData } = require('../../store/index')const delay = new DelayQueueExector(10000);/** * @method say 机器人发送消息 * @param {*} messageType 消息类型 7文本,1文件,6图片,3个人名片,14卡片链接 9小程序 * @param {*} sender 来源 房间 || 个人 实例对象 * @param {*} messageInfo 内容 *//** * messageInfo 数据结构 * tetx: string 文本消息必传 * fileUrl: string 文件消息必传 * imageUr: string 图片消息必传 * cardId: string 个人名片消息必传 * linkInfo: object 卡片消息必传 * description: string 描述 * thumbnailUrl: string 缩略图地址 * title: string 标题 * url: string 跳转地址 */async function say({ messageType, sender, messageInfo }) { // console.log(messageType); // console.log(sender); // console.log(messageInfo); try { return new Promise(async (resolve, reject) => { // 机器人信息 const { bot } = globalData // 枚举消息类型 const MessageType = { text: 7, // 文本 fromFile: 1, // 文件 fromUrl: 6, // 图片 contactCard: 3, // 个人名片 urlLink: 14, // 卡片链接 miniProgram: 9, // 小程序 } // 内容不存在 if (!messageInfo) { return } // 要发送的消息内容 let content switch (messageType) { // 文本 7 case MessageType.text: content = messageInfo.text break; // 文件 1 case MessageType.fromFile: content = FileBox.fromFile(messageInfo.fromFile) break; // 图片 6 case MessageType.fromUrl: content = FileBox.fromUrl(messageInfo.fromUrl) break; // 个人名片 3 case MessageType.contactCard: content = await bot.Contact.load('1688853777824721') break; // 链接 14 case MessageType.urlLink: content = new UrlLink({ description: 'WeChat Bot SDK for Individual Account, Powered by TypeScript, Docker, and Love', thumbnailUrl: 'https://avatars0.githubusercontent.com/u/25162437?s=200&v=4', title: 'Welcome to Wechaty', url: 'https://github.com/wechaty/wechaty', }) break; // 小程序 9 case MessageType.miniProgram: content = new MiniProgram({ appid: 'wx60090841b63b6250', title: '我正在使用Authing认证身份,你也来试试吧', pagePath: 'pages/home/home.html', description: '身份管家', thumbUrl: '30590201000452305002010002041092541302033d0af802040b30feb602045df0c2c5042b777875706c6f61645f31373533353339353230344063686174726f6f6d3131355f313537363035393538390204010400030201000400', thumbKey: '42f8609e62817ae45cf7d8fefb532e83', }); break; default: break; } delay.execute(async () => { sender.say(content) .then(value => { console.log(`======================== 机器人回复 ========================/n/n`) resolve() }) .catch(reason => { console.log(`======================== 机器人发送消息失败 ========================/n/n`, reason) }) }) }) } catch (error) { console.log('error in say', error); }}module.exports = { say}
对了,对于onMessage事件中消息格式的判断我也做了一层封装,这里给大家提供参考。/** * @method messageProcessing 处理消息内容 * @param {*} message */async function messageProcessing(message) { try { return new Promise(async (resolve, reject) => { console.log(`======================== messageProcessing ========================/n/n`) // 消息详情 const messagePayload = message.payload // 获取消息的文本内容。 let text = message.text() /** * Unknown: 0, Attachment: 1, Audio: 2, Contact: 3, ChatHistory: 4, Emoticon: 5, Image: 6, Text: 7, Location: 8, MiniProgram: 9, GroupNote: 10, Transfer: 11, RedEnvelope: 12, Recalled: 13, Url: 14, Video: 15 */ // 消息类型 switch (messagePayload.type) { // 附件 0 case Message.Type.Unknown: console.log(`======================== 消息类型为未知消息:${messagePayload.type} ========================/n/n`) text = '[你收到一个未知消息,请在手机上查看]' break; // 附件 1 case Message.Type.Attachment: console.log(`======================== 消息类型为附件:${messagePayload.type} ========================/n/n`) // 暂时不知道怎么处理 text = '[你收到一个附件,请在手机上查看]' break; // 音频 2 case Message.Type.Audio: console.log(`======================== 消息类型为音频:${messagePayload.type} ========================/n/n`) text = '[你收到一条语音消息,请在手机上查看]' break; // 个人名片 3 case Message.Type.Contact: console.log(`======================== 消息类型为个人名片:${messagePayload.type} ========================/n/n`) text = '[你收到一张个人名片,请在手机上查看]' break; // 聊天记录 4 case Message.Type.ChatHistory: console.log(`======================== 消息类型为聊天记录:${messagePayload.type} ========================/n/n`) text = '[你收到聊天记录,请在手机上查看]' break; // 表情符号 5 case Message.Type.Emoticon: console.log(`======================== 消息类型为表情符号:${messagePayload.type} ========================/n/n`) text = '[你收到表情符号,请在手机上查看]' // 暂时不知道怎么处理 break; // 图片 6 case Message.Type.Image: console.log(`======================== 消息类型为图片:${messagePayload.type} ========================/n/n`) // 上传图片至阿里云获取图片地址 text = await addImageOss(message) break; // 文本 7 case Message.Type.Text: console.log(`======================== 消息类型为文本:${messagePayload.type} ========================/n/n`) // 去空格换行 text = text.replace(//s+/g, '') break; // 位置 8 case Message.Type.Location: console.log(`======================== 消息类型为位置:${messagePayload.type} ========================/n/n`) text = '[你收到一条图片消息,请在手机上查看]' break; // 小程序 9 case Message.Type.MiniProgram: console.log(`======================== 消息类型为小程序:${messagePayload.type} ========================/n/n`) text = '[你收到一个小程序消息,请在手机上查看]' break; // GroupNote 10 case Message.Type.GroupNote: console.log(`======================== 消息类型为GroupNote:${messagePayload.type} ========================/n/n`) text = '[你收到一个GroupNote,请在手机上查看]' break; // Transfer 11 case Message.Type.Transfer: console.log(`======================== 消息类型为Transfer:${messagePayload.type} ========================/n/n`) text = '[你收到一个Transfer,请在手机上查看]' break; // 红包 12 case Message.Type.RedEnvelope: console.log(`======================== 消息类型为红包:${messagePayload.type} ========================/n/n`) text = '[你收到一个红包,请在手机上查看]' break; // Recalled 13 case Message.Type.Recalled: console.log(`======================== 消息类型为Recalled:${messagePayload.type} ========================/n/n`) text = '[你收到一个Recalled,请在手机上查看]' break; // 链接地址 14 case Message.Type.Url: console.log(`======================== 消息类型为链接地址:${messagePayload.type} ========================/n/n`) // 暂时不知道怎么处理 text = '[你收到一条链接消息,请在手机上查看]' break; // 视频 15 case Message.Type.Video: console.log(`======================== 消息类型为视频:${messagePayload.type} ========================/n/n`) text = '[你收到一个视频消息,请在手机上查看]' break; default: text = '' break; } resolve(text) }) } catch (error) { console.log('error in messageProcessing', error); }}
为什么这样做一层封装处理,是因为我们的业务需求要将聊天内容进行redis和mysql数据存储。方便以后数据订正和查询使用。关键词:机器,助手,企业