创建推送渠道 - PeerBanHelper WebAPI

建议在创建/保存之前，先调用推送渠道测试接口，测试用户填写的配置有效再调用此接口。
当 DraftPushProvider 中的 name 和请求 Param {name} 不同时，PBH 会按照重命名处理，删除旧的并添加新的

SMTP 推送:

{
    "name": "qqmail",
    "type": "smtp",
    "config": {
        "host": "smtp.qq.com",
        "port": "587",
        "auth": true,
        "username": "2908803755@qq.com",
        "password": "********************",
        "sender": "2908803755@qq.com",
        "senderName": "PeerBanHelper",
        "receivers": [
            "2908803755@qq.com"
        ],
        "encryption": "STARTTLS", // 常量，NONE, STARTTLS, ENFORCE_STARTTLS, SSLTLS
        "sendPartial": true
    }
}

推送加：

{
    "name": "pushplus+",
    "type": "pushplus",
    "config": {
      "token": "1234567890",
      "topic": null,
      "template": null,
      "channel": null
    }
}

Server 酱：

{
    "name": "Server酱",
    "type": "serverchan",
    "config": {
      "sendkey": "1234567890",
      "channel": "channel",
      "openid": "openid"
    }
}

Telegram：

{
    "name": "Telegram纸飞机",
    "type": "telegram",
    "config": {
      "token": "1234567890",
      "chatid": "123456789"
    }
}

Bark：

{
    "name": "Bark APP",
    "type": "bark",
    "config": {
      "device_key": "somekeyhere"
    }
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

name

string

推送渠道名称

必需

避免使用特殊符号，建议过滤：字母、数字、下划线

config

object

JSON 配置块

必需

配置文件块，根据下推送渠道的类型不同，其中的字段和参数可能均不相同

示例

{
  "name": "Telegram纸飞机",
  "type": "telegram",
  "config": {
    "token": "1234567890",
    "chatid": "123456789"
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢201成功

application/json

Body

success

boolean

必需

message

string

提示信息

必需

data

null

必需

示例

{
  "success": true,
  "message": "推送渠道创建成功",
  "data": null
}

🟠403未登录或Token错误

🟠429IP地址因频繁失败尝试而被封禁

🔴500内部服务器错误

🟠400参数有误