更新记录

1.0.0（2024-03-10）

第一版

平台兼容性

PushSend

www.pushplus.plus

描述

PushSend是一个对PushPlus API的封装类，用于简化向指定渠道发送自定义消息的过程。通过实例化该类并调用其send方法，可以方便地将不同格式的消息推送到微信公众号、企业微信、邮件、短信等多种渠道。

构造函数

new PushSend(token)

• token (String): PushPlus平台提供的令牌。

方法：send

pushSendInstance.send(title, content, topic = 1, template = 'html', channel = 'wechat', callbackUrl = () => {})

参数说明：

• title (String): 必填项，消息标题。
• content (String): 必填项，消息内容主体，内容格式根据template参数选择。
• topic (Number): 可选参数，默认值为 1，用于区分不同的消息类别或场景。
• template (String): 指定消息模板类型，可选项包括：
  • 'html': 支持HTML文本格式，默认模板。
  • 'txt': 纯文本内容，不转义HTML标签，换行使用\n。
  • 'json': 可视化展示JSON格式内容。
  • 'markdown': 基于Markdown格式的内容展示。
  • 'cloudMonitor': 阿里云监控报警定制模板。
  • 'jenkins': Jenkins插件定制模板。
  • 'route': 路由器插件定制模板。
  • 'pay': 支付成功通知模板。
• channel (String): 指定发送渠道，可选项包括：
  • 'wechat': 微信公众号，默认发送渠道。
  • 'webhook': 第三方Webhook服务，如企业微信机器人、钉钉机器人、飞书机器人等。
  • 'cp': 企业微信应用。
  • 'mail': 邮件发送。
  • 'sms': 短信发送（注意：此服务为收费服务，每条短信扣减10积分）。
• callbackUrl (Function): 成功回调函数，接收一个参数（响应对象 res），在消息发送成功后执行。

示例

const pushSend = new PushSend('your_token_here');

pushSend.send(
  '重要通知',
  '这是一条HTML格式的消息内容',
  1,
  'html',
  'wechat',
  function(res) {
    console.log('推送结果：', res);
  }
);

通过这个封装后的PushSend类，您可以轻松实现与PushPlus服务的对接，灵活发送各类消息至您需要的渠道。