workwechat-bot

企业微信群机器人消息推送辅助工具。服务端客户端通用。

安装

npm i workwechat-bot

使用

// NodeJS 环境下引入：
const Bot = require('workwechat-bot').default;
// ESM：
import Bot from 'workwechat-bot';

const bot1 = new Bot([
  'bot-hook-1',
  'bot-hook-2',
]);

const bot2 = new Bot('bot-hook-2');

bot1
  .text('123')
  .text('456')
  .at('user1')
  .at(['user2', 'user3'])
  .send();

bot2.markdown('# markdown').text('55').send();

API

send

不论是调用 text 还是 markdown 还是 at，都不会直接发送消息，他们用户设置消息队列。

当调用 send 的时候，会发送所有设置好的消息，并将消息队列清空。

const bot = new Bot('bot-hook');

bot.text('abc').send();

bot.markdown('# markdown').send({
  // 不会清空消息队列
  clearMsgQueue: false,
});

seriesSend

顺序的发送消息。当对发送的消息有时序要求时可以用这个方法。条件以企业微信机器人响应为准。

const bot = new Bot('bot-hook');

await bot
  .text('abc')
  .at('user1')
  .at('user2')
  .seriesSend();

parallelSend

const bot = new Bot('bot-hook');

await bot
  .text('abc')
  .at('user1')
  .at('user2')
  .parallelSend();

console.log('next');

text

发送文本消息。

const bot = new Bot('bot-hook');

// 发送文本为 text 的消息
bot.text('text');
// 发送文本为 text，并且会 at id为user1的用户
bot.text('text', 'user1');
// 发送文本为 text，并且会 at id为user1 和 user2的用户
bot.text('text', ['user1', 'user2']);
// 发送文本为 text，并且会 at id为user1的用户与 手机为 13212312121 的用户
bot.text('text', {
  mentioned: ['user1'],
  mentionedMobile: ['13212312121'],
});

bot.send();

at

发送 @成员 消息。

const bot = new Bot('bot-hook');

// 会 @ id为 user1 的用户
bot.at('user1');
// 会 @ id为 user1 和 user2 的用户
bot.at(['user1', 'user2']);
// 会 @ id为user1的用户与 手机为 13212312121 的用户
bot.at({
  mentioned: ['user1'],
  mentionedMobile: ['13212312121'],
});

image

发送图片。

const bot = new Bot('bot-hook');

bot.image('base64', 'md5');

bot.send();

news

发送图文消息。

const bot = new Bot('bot-hook');

bot.news({
  title: '标题',
  desc: '描述',
  url: 'https://tar.get',
  cover: '封面',
});

bot.news([
  {
    title: '标题',
    desc: '描述',
    url: 'https://tar.get',
    cover: '封面',
  },
  {
    title: '标题',
    desc: '描述',
    url: 'https://tar.get',
    cover: '封面',
  },
]);

bot.send();

markdown

发送 markdown 消息。

const bot = new Bot('bot-hook');

bot.markdown('# markdown').send();

uploadFile

每个机器人只能发送自己上传的文件，串着发可能会浪费发送配额

上传文件，获取 media_id。

const bot = new Bot('bot-hook');

const img = fs.createReadStream(path.resolve(__dirname, './test.jpg'));

const { media_id } = await bot.uploadFile(img, 'test.jpg');

如果注册了多个机器人，每个机器人都会去做上传动作，最后 uploadFile 方法会返回多个响应组成的数组，顺序和传入的 hook 一致。

const bot = new Bot([
  'hook1',
  'hook2',
]);

const img = fs.createReadStream(path.resolve(__dirname, './test.jpg'));

const [
  { media_id: mediaId1, bot: bot1 },
  { media_id: mediaId2, bot: bot2 },
] = await bot.uploadFile(img, 'test.jpg');

file

发送文件，需要提供 media_id。

const bot = new Bot('bot-hook');

const img = fs.createReadStream(path.resolve(__dirname, './test.jpg'));

const { media_id } = await bot.uploadFile(img, 'test.jpg');

bot.file(media_id).send();

__clearMsgQueue

清空队列。

const bot = new Bot('bot-hook');

bot.text('123');

bot.__clearMsgQueue();

bot.send();