all-pusher-api

统一化推送服务Nodejs API. 已支持钉钉, Discord, 邮件, 飞书, PushDeer, PushPlus, QQ, QQ 频道机器人, Server 酱, Showdoc Push, Telegram Bot, 企业微信群机器人, 息知, WxPusher, ~~NowPush~~, iGot, Chanify, Bark, Push, Slack, Pushback, Zulip, RocketChat, Gitter等平台.

！！！！！仅推送！！！！！不交互！！！！！！

已支持平台

• QQ(go-cqhttp) -- GoCqhttp
• ~~QQ(Qmsg) -- Qmsg~~
• QQ 频道机器人 -- QqChannel
• 钉钉群机器人 -- DingTalk
• Discord -- Discord
• 邮件 -- Mail
• 飞书群机器人 -- FeiShu
• 企业微信 -- WorkWeixin
• 企业微信群机器人 -- WorkWeixinBot
• Telegram Bot -- TelegramBot
• PushDeer -- PushDeer
• PushPlus -- PushPlus
• Server 酱 -- ServerChanTurbo
• Showdoc Push -- Showdoc
• 息知 -- Xizhi
• WxPusher -- WxPusher
• ~~NowPush -- NowPush~~
• iGot -- IGot
• Chanify -- Chanify
• Bark -- Bark
• GoogleChat -- GoogleChat
• Push -- Push
• Slack -- Slack
• Pushback -- Pushback
• Zulip -- Zulip
• RocketChat -- RocketChat
• ~~Gitter -- Gitter~~
• Pushover -- Pushover
• 爱语飞飞 -- Iyuu
• Ntfy -- Ntfy
• 一封传话 -- YiFengChuanHua
• WPush -- WPush

安装

npm install all-pusher-api -S

使用

Example

多平台推送

const { PushApi } = require('all-pusher-api'); // 多平台同时推送

(async () => {
  console.log((await new PushApi([
    {
      name: 'ServerChanTurbo',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'PushDeer',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'WxPusher',
      config: {
        key: {
          token: '******',
          uids: ['******']
        }
      }
    },
    {
      name: 'PushPlus',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'Showdoc',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'Xizhi',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'QqChannel',
      config: {
        key: {
          appID: '******',
          token: '******'
        },
        channelID: '******'
      }
    },
    {
      name: 'WorkWeixin',
      config: {
        corpid: '******',
        secret: '******',
        agentid: ******,
        touser: '******'
      }
    },
    {
      name: 'Mail',
      config: {
        key: {
          host: '******',
          port: 465,
          secure: true,
          auth: {
            user: '******',
            pass: '******'
          }
        },
        options: {
          from: '******',
          to: '******'
        }
      }
    },
    {
      name: 'TelegramBot',
      config: {
        token: '******',
        chat_id: '******'
      }
    },
    {
      name: 'DingTalk',
      config: {
        key: {
          token: '******',
          secret: '******'
        }
      }
    },
    {
      name: 'FeiShu',
      config: {
        key: {
          token: '******',
          secret: '******'
        }
      }
    },
    {
      name: 'Discord',
      config: {
        webhook: '******',
        proxy: {
          enable: true,
          host: '127.0.0.1',
          port: 1080
        }
      }
    },
    {
      name: 'GoCqhttp',
      config: {
        key: {
          token: '******',
          baseUrl: 'http://127.0.0.1:5700',
          user_id: '******'
        }
      }
    },
    {
      name: 'NowPush',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'IGot',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'WorkWeixinBot',
      config: {
        key: {
          webhook: '******'
        }
      }
    },
    {
      name: 'Chanify',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'Bark',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'GoogleChat',
      config: {
        key: {
          webhook: '******'
        },
        proxy: {
          enable: true,
          host: '127.0.0.1',
          port: 1080
        }
      }
    },
    {
      name: 'Push',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'Slack',
      config: {
        key: {
          webhook: '******'
        }
      }
    },
    {
      name: 'Pushback',
      config: {
        key: {
          token: 'at_******',
          userId: 'User_****'
        }
      }
    },
    {
      name: 'Zulip',
      config: {
        key: {
          token: '******',
          email: '******',
          domain: '******',
          to: '["******""]'
        }
      }
    },
    {
      name: 'RocketChat',
      config: {
        key: {
          webhook: '******'
        }
      }
    },
    {
      name: 'Pushover',
      config: {
        key: {
          token: '******',
          user: '******'
        }
      }
    },
    {
      name: 'Iyuu',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'Ntfy',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'YiFengChuanHua',
      config: {
        key: {
          token: '******'
        }
      }
    },
    {
      name: 'WPush',
      config: {
        key: {
          token: '******'
        }
      }
    }
  ])
    .send({ message: '测试文本' })).map((e) => (e.result.status >= 200 && e.result.status < 300) ? `${e.name} 测试成功` : e));
})();

单平台推送

(async () => {
  // Example 1
  const { PushApi } = require('all-pusher-api'); // 多平台同时推送

  const result = await new PushApi([
    {
      name: 'ServerChanTurbo',
      config: {
        key: {
          token: '******'
        }
      }
    }
  ])
    .send({ message: '测试文本' });
  console.log(result.map((e) => (e.result.status >= 200 && e.result.status < 300) ? `${e.name} 测试成功` : e));

  // Example 2
  const { WxPusher } = require('all-pusher-api/dist/WxPusher'); // 单平台推送可选

  const wxPusherResult = await new WxPusher({
    token: '******',
    uids: ['******']
  })
    .send({ message: '测试文本' });
  console.log(wxPusherResult);
})();

extraOptions

(async () => {
  const { DingTalk } = require('all-pusher-api/dist/DingTalk');

  const result = await new DingTalk({
    key: {
      token: '******',
      secret: '******'
    }
  })
    .send({
      message: '这条消息@了所有人',
      extraOptions: {
        isAtAll: true
      }
    });
  console.log(result);
})();

customOptions

这里以钉钉为例

(async () => {
  const { DingTalk } = require('all-pusher-api/dist/DingTalk');

  const result = await new DingTalk({
    key: {
      token: '******',
      secret: '******'
    }
  })
    .send({
      customOptions: {
        "msgtype": "actionCard",
        "actionCard": {
          "title": "我 20 年前想打造一间苹果咖啡厅, 而它正是 Apple Store 的前身",
          "text": "![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png) \n\n #### 乔布斯 20 年前想打造的苹果咖啡厅 \n\n Apple Store 的设计正从原来满满的科技感走向生活化, 而其生活化的走向其实可以追溯到 20 年前苹果一个建立咖啡馆的计划",
          "btnOrientation": "0",
          "btns": [
            {
                "title": "内容不错",
                "actionURL": "https://www.dingtalk.com/"
            },
            {
                "title": "不感兴趣",
                "actionURL": "https://www.dingtalk.com/"
            }
          ]
        }
      }
    });
  console.log(result);
})();

自定义接口

(async () => {
  const { Custom } = require('all-pusher-api/dist/Custom'); // 自定义接口只能通过此方法引入
  const { createHmac } = require('crypto');
 const sign = () => {
    const timestamp = new Date().getTime();
    const secret = '******';
    const stringToSign = `${timestamp}\n${secret}`;
    const hash = createHmac('sha256', secret)
      .update(stringToSign, 'utf8')
      .digest();
    return `timestamp=${timestamp}&sign=${encodeURIComponent(hash.toString('base64'))}`;
  };
  console.log(await new Custom({
    url: `https://oapi.dingtalk.com/robot/send?access_token=******&${sign()}`,
    success: {
      key: 'responseData.errcode',
      value: 0
    }
  }).send({
    msgtype: 'text',
    text: {
      content: '测试文本'
    }
  }));
  /* 返回值
  {
    status: 200,
    statusText: 'Success',
    extraMessage: <AxiosResponse>
  }
  */
});

参数

pusherConfig

const pusher = new WxPusher(pusherConfig);

参数生成器

CustomConfig

自定义接口

const customPusher = new Custom(CustomConfig);

pushersConfig

const pushers = new PushApi(pushersConfig);

const pushersConfig: Array<{
  name: string,
  config: pusherConfig
}>

sendOptions

const result = await pusher.send(sendOptions);

customSendOptions

const result = await customPusher.send(customSendOptions);

customSendOptions会直接作为请求体发送, 具体请查看示例.

pushersSendConfig

const results = await pushers.send(pushersSendConfig);

const pushersSendConfig: Array<{
  name: string
  config: pushersSendConfig
}>

返回值

result

const result = await pusher.send(sendOptions);

results

const results = await pushers.send(pushersSendConfig);

const results: Array<{
  name: string
  result: result
}>

支持的消息类型

所有平台支持均纯文本(text)格式消息, 大部分支持markdown格式消息, 部分支持html格式消息

markdown*为支持html格式不支持markdown格式消息时自动将markdown转换为html格式

other为部分平台支持特殊格式的消息, 可通过customOptions传入参数, 具体参数请查看相应平台的文档

• Showdoc: 'text'
• Pushover: 'text'
• 爱语飞飞: 'text'
• QQ(go-cqhttp): 'text', 'other'
• ~~Qmsg: 'text', 'other'~~
• Discord: 'text', 'other'
• 飞书: 'text', 'other'
• ~~NowPush: 'text', 'other'~~
• Chanify: 'text', 'other'
• Bark: 'text', 'other'
• Server酱Turbo: 'text', 'markdown'
• 息知: 'text', 'markdown'
• WPush: 'text', 'markdown'
• PushDeer: 'text', 'markdown', 'other'
• QQ频道: 'text', 'markdown', 'other'
• 企业微信: 'text', 'markdown', 'other'
• 企业微信群机器人: 'text', 'markdown', 'other'
• 钉钉: 'text', 'markdown', 'other'
• TelegramBot: 'text', 'markdown', 'html'
• 一封传话: 'text', 'markdown', 'html'
• 邮件: 'text', 'markdown*', 'html'
• PushPlus: 'text', 'markdown*', 'html'
• WxPusher: 'text', 'markdown*', 'html'

状态码

• 0-Missing Parameter: ***: 缺少必要参数
• 10-Missing Options: 缺少发送消息配置
• 11-Unknown Error: 未知错误
• 200-Success: 推送成功
• 201-Waiting: 待审核
• 100-Error: 请求发送成功, 服务器返回错误信息
• 101-No Response Data: 请求发送成功, 但没有接收到服务器返回的数据
• 102-Request Error: 请求发送失败, 一般是网络问题
• 103-Options Format Error: 参数格式错误
• 104-Get "***" Failed: 获取参数失败
• 140-Check Sign Failed: 签名校检失败