weworkbot v1.3.0

weworkbot

企业微信群聊机器人, Node js >= v10

官方文档地址

https://developer.work.weixin.qq.com/document/path/91770

安装

npm i weworkbot

注意

因为企业微信限制了每个机器人最大以20条/分钟发送，所以集成了bull队列用来控制发送频率。如果没有用过bull的话，可以参考一下bull的文档。如果没有设置bull队列的话，则会直接发送消息，但是就有可能会受到机器人消息限流

使用

import { WeWorkBot } from 'weworkbot'
const { mdContent } = require('./content')

/**
 * 项目依赖bull队列来做限流，这里需要传入一个bull队列的实例，请自己实例化这个队列实例
  并保证将限流设置为
  limiter: {
    max: 1,
    duration: 3000,
    groupKey: 'key' // 每个机器人一个限流
  },
  如果不设置队列也行，但是就有可能受到微信的限流
 */
WeWorkBot.setQueue(que)

const bot = new WeWorkBot({
  key: 'xxxx',
})

/** 发送文本消息 */
bot.sendText({
  content: '文本测试消息',
  mentioned_list: ['@all'],
})

/** 发送markdown消息 */
bot.sendMarkDown(mdContent)

/** 发送图片消息 */
bot.sendImage('test/test_file.jpg')

/** 发送图文消息 */
bot.sendNews([
  {
    title: '测试图文标题',
    url: 'https://www.qq.com',
    description: '测试图文描述',
    picurl:
      'http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png',
  },
])

/** 上传并发送文件 */
bot
  .upload({
    filePath: 'test/test_file.jpg',
  })
  .then((mid) => {
    bot.sendFile(mid)
  })

文本通知模版卡片

图文展示模版卡片