qywechat v1.0.1

qywechat

向企业微信群组发送消息

Features

• 🚀 支持文本、markdown、图片、图文、文件、语音、模板卡片七种消息类型。
• 🤖️ 完善的类型提示

Install

npm install --save qywechat

Usage

import { sendText } from 'qywechat';

await sendText({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  content: '广州今日天气：29度，大部分多云，降雨概率：60%',
});

API

sendText

发送文本类型消息，详细可查看企业微信文档。

sendText({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  content: '广州今日天气：29度，大部分多云，降雨概率：60%',
  mentioned_list: ['wangqing', '@all'],
  mentioned_mobile_list: ['13800001111', '@all'],
});

sendMarkdown

发送 markdown 消息，详细可查看企业微信文档。

sendMarkdown({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  content:
    '实时新增用户反馈<font color="warning">132例</font>，请相关同事注意。',
});

sendImage

发送图片类型消息，详细可查看企业微信文档。

sendImage({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  base64: 'DATA',
  md5: 'MD5',
});

sendNews

发送图文类型消息，详细可查看企业微信文档。

sendNews({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  articles: [
    {
      title: '中秋节礼品领取',
      description: '今年中秋节公司有豪礼相送',
      url: 'www.qq.com',
      picurl: 'http://xxx.png',
    },
  ],
});

sendFile

发送文件类型消息，详细可查看企业微信文档。

sendFile({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  media_id: '3a8asd892asd8asd',
});

sendVoice

发送语音类型消息，详细可查看企业微信文档。

sendVoice({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  media_id: 'MEDIA_ID',
});

sendTextNoticeCard

发送文本通知模版卡片消息，详细可查看企业微信文档。

sendTextNoticeCard({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  source: {
    icon_url:
      'https://wework.qpic.cn/wwpic/252813_jOfDHtcISzuodLa_1629280209/0',
    desc: '企业微信',
    desc_color: 0,
  },
  main_title: {
    title: '欢迎使用企业微信',
    desc: '您的好友正在邀请您加入企业微信',
  },
  emphasis_content: {
    title: '100',
    desc: '数据含义',
  },
  quote_area: {
    type: 1,
    url: 'https://work.weixin.qq.com/?from=openApi',
    appid: 'APPID',
    pagepath: 'PAGEPATH',
    title: '引用文本标题',
    quote_text: 'Jack：企业微信真的很好用~\nBalian：超级好的一款软件！',
  },
  sub_title_text: '下载企业微信还能抢红包！',
  horizontal_content_list: [
    {
      keyname: '邀请人',
      value: '张三',
    },
    {
      keyname: '企微官网',
      value: '点击访问',
      type: 1,
      url: 'https://work.weixin.qq.com/?from=openApi',
    },
    {
      keyname: '企微下载',
      value: '企业微信.apk',
      type: 2,
      media_id: 'MEDIAID',
    },
  ],
  jump_list: [
    {
      type: 1,
      url: 'https://work.weixin.qq.com/?from=openApi',
      title: '企业微信官网',
    },
    {
      type: 2,
      appid: 'APPID',
      pagepath: 'PAGEPATH',
      title: '跳转小程序',
    },
  ],
  card_action: {
    type: 1,
    url: 'https://work.weixin.qq.com/?from=openApi',
    appid: 'APPID',
    pagepath: 'PAGEPATH',
  },
});

sendNewsNoticeCard

发送图文展示模版卡片消息，详细可查看企业微信文档。

sendNewsNoticeCard({
  url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=<yourkey>',
  source: {
    icon_url:
      'https://wework.qpic.cn/wwpic/252813_jOfDHtcISzuodLa_1629280209/0',
    desc: '企业微信',
    desc_color: 0,
  },
  main_title: {
    title: '欢迎使用企业微信',
    desc: '您的好友正在邀请您加入企业微信',
  },
  card_image: {
    url: 'https://wework.qpic.cn/wwpic/354393_4zpkKXd7SrGMvfg_1629280616/0',
    aspect_ratio: 2.25,
  },
  image_text_area: {
    type: 1,
    url: 'https://work.weixin.qq.com',
    title: '欢迎使用企业微信',
    desc: '您的好友正在邀请您加入企业微信',
    image_url:
      'https://wework.qpic.cn/wwpic/354393_4zpkKXd7SrGMvfg_1629280616/0',
  },
  quote_area: {
    type: 1,
    url: 'https://work.weixin.qq.com/?from=openApi',
    appid: 'APPID',
    pagepath: 'PAGEPATH',
    title: '引用文本标题',
    quote_text: 'Jack：企业微信真的很好用~\nBalian：超级好的一款软件！',
  },
  vertical_content_list: [
    {
      title: '惊喜红包等你来拿',
      desc: '下载企业微信还能抢红包！',
    },
  ],
  horizontal_content_list: [
    {
      keyname: '邀请人',
      value: '张三',
    },
    {
      keyname: '企微官网',
      value: '点击访问',
      type: 1,
      url: 'https://work.weixin.qq.com/?from=openApi',
    },
    {
      keyname: '企微下载',
      value: '企业微信.apk',
      type: 2,
      media_id: 'MEDIAID',
    },
  ],
  jump_list: [
    {
      type: 1,
      url: 'https://work.weixin.qq.com/?from=openApi',
      title: '企业微信官网',
    },
    {
      type: 2,
      appid: 'APPID',
      pagepath: 'PAGEPATH',
      title: '跳转小程序',
    },
  ],
  card_action: {
    type: 1,
    url: 'https://work.weixin.qq.com/?from=openApi',
    appid: 'APPID',
    pagepath: 'PAGEPATH',
  },
});

LICENSE

MIT