BiliOutils

Appearance

消息推送 ​

[message]

Key值类型说明
br字符串主要配合 api 使用，有的 api 换行是\n，有的是需要\n\n
onlyError布尔值仅错误时发送
email点击了解
pushplusToken字符串官网获取 token
api字符串或对象自定义推送 API，详见
从青龙面板移植环境变量你在找微信，tg，serverChan？不妨看这里
参考配置
json5
{
  message: {
    br: '\n',
    onlyError: false,
    email: {
      from: 'xxxxxxxxx',
      to: 'xxxxxxxxx',
      pass: 'xxxxxxxxx',
      host: 'smtp.xxx.com',
      port: 465,
    },
    pushplusToken: 'xxxxxxxxxxxxxxx',
    SCKEY: 'xxxxxxxx',
  },
}

Email ​

[email]

Key值类型默认值举例说明
from字符串mhtwrnm@qq.com发件邮箱
to字符串from 的值mhtwrnm@qq.com接收邮箱
pass字符串发件邮箱的授权码
host字符串smtp.163.com
port数值465host 的端口

来自青龙面板 ​

下列环境变量来自 青龙面板

具体介绍看这里 https://github.com/whyour/qinglong/blob/develop/sample/config.sample.sh 支持 serverChan（Server 酱）、Telegram（Telegram）、Wechat（微信）等

支持以下三种方式填写：

  • 环境变量，如 PUSH_PLUS_TOKEN
  • 通过在配置中的 message 字段中配置，以下两种方式都可以。
    json
    {
  "message": {
    "PUSH_PLUS_TOKEN": "xxxxxxxx",
    "pushPlusToken": "xxxxxxxx",
    "SCKEY": "xxxxxxxx",
    "sckey": "xxxxxxxx"
  }
}

由于青龙面板在不断更新，但是这里可能没有更，下面列出支持的列表：

js
{
  'GOBOT_URL',
  'GOBOT_TOKEN',
  'GOBOT_QQ',
  'SCKEY': 'server酱',
  'QQ_SKEY',
  'QQ_MODE',
  'BARK_PUSH',
  'BARK_SOUND',
  'BARK_GROUP',
  'TG_BOT_TOKEN': 'telegram',
  'TG_USER_ID',
  'TG_PROXY_AUTH',
  'TG_PROXY_HOST',
  'TG_PROXY_PORT',
  'TG_API_HOST',
  'DD_BOT_TOKEN',
  'DD_BOT_SECRET',
  'QYWX_KEY': '企业微信',
  'QYWX_AM': '企业微信应用消息',
  'IGOT_PUSH_KEY': 'iGot',
  'PUSH_PLUS_TOKEN',
  'PUSH_PLUS_USER',
};

自定义推送 API ​

简单 GET 请求 ​

json5
{
  message: {
    api: 'http://www.pushplus.plus/send?token=xxxxxxxxxxxxx&title={title}&content={text}',
  },
}

上面使用的是 pushplus 举例。

  • 链接中的 token 是用户自己的 token，title 和 text 是推送的标题和内容，更多参数详见 pushplus 文档。
  • 最重要的是 title={title}&content={text}，{title} 和 {text} 会被替换成推送的标题和内容。

再举一个 serverChan 的例子 https://sctapi.ftqq.com/SCTxxxxxxxxxxxxxx.send?title={title}&desp={text}

详细自定义 ​

json5
{
  message: {
    api: {
      // url 必填，query 参数请直接拼接到 url 中
      url: '',
      // 方法，默认值 POST，支持 GET、POST、PUT、DELETE、PATCH 等
      method: 'POST',
      // 头部，默认值如下
      headers: {
        'Content-Type': 'application/json',
      },
      // 超时时间，默认值 5s
      timeout: 5000,
      // 设置 https 代理
      proxy: {
        host: '',
        port: 443,
        auth: '',
      },
      // 请求体，使用 GET 方法时，请留空
      data: {},
    },
  },
}

使用 pushplus 的 POST 方法举例。

json5
{
  message: {
    api: {
      url: 'http://www.pushplus.plus/send',
      data: {
        token: 'xxxxxxxxxxxxxxxxxxx',
        title: '{title}',
        content: '{text}',
      },
    },
  },
}
  • 链接中的 token 是用户自己的 token，title 和 text 是推送的标题和内容，更多参数详见 pushplus 文档。
  • 最重要的是 title: {title} , content: {text}，{title} 和 {text} 会被替换成推送的标题和内容。
  • 请求方法和 header 都可以使用默认值

再使用 serverChan 的 POST 方法举例。

json5
{
  message: {
    api: {
      url: 'https://sctapi.ftqq.com/xxxxxxxxxxxxxxxx.send',
      data: {
        title: '{title}',
        desp: '{text}',
      },
      headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
      },
    },
  },
}
  • 这里的 header 需要修改，因为默认的是 application/json，而 serverChan 需要 application/x-www-form-urlencoded