编辑推送渠道

开发中

PATCH

/api/push/{pushName}

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

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

pushName

string

必需

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

curl --location --request PATCH 'http://127.0.0.1:9898/api/push/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Telegram纸飞机",
    "type": "telegram",
    "config": {
      "token": "1234567890",
      "chatid": "123456789"
    }
}'

返回响应

🟢200成功

application/json

Body

success

boolean

必需

message

string

提示信息

必需

data

null

必需

示例

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

🟠403未登录或Token错误

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

🔴500内部服务器错误

🟠400参数有误

修改于 2024-12-01 07:46:07

创建推送渠道

测试通知渠道