当前为开发环境,请使用 App 为此服务器注册生成的 Webhook。
参数
以下名称可用于查询字符串、表单或 JSON。名称不区分大小写,值可以是字符串或数字。Breeze 沿用 Bark 的参数名,大多数 Bark 脚本无需修改即可使用。平台一列中的“全部”表示 iPhone 和 Android 都支持。
内容#
| 参数 | 说明 | 平台 |
|---|---|---|
title |
标题 | 全部 |
subtitle |
副标题 | 全部 |
body |
正文。也可用 message |
全部 |
markdown |
Markdown 正文。横幅显示纯文本,历史记录显示排版后的内容。替代 body 使用 |
全部 |
group |
在通知中心和历史记录中分组。也可用 thread_id |
全部 |
url |
点击通知时打开的 HTTPS 链接 | 全部 |
image |
在通知和历史记录中显示的 HTTPS 图片 | 全部 |
icon |
作为发送者头像显示的 HTTPS 图片 | 全部 |
copy |
通知“复制”操作复制的文字,默认为正文 | 全部 |
autoCopy |
1 表示通知到达时自动把 copy(或正文)复制到剪贴板 |
iOS |
badge |
App 图标上的数字。0 清除 |
iOS |
声音与提醒级别#
| 参数 | 说明 | 平台 |
|---|---|---|
sound |
内置或自定义铃声名称,或 default。Android 只播放 default。见 声音与提醒级别 |
全部 |
call |
1 表示铃声重复 30 秒,像来电一样 |
iOS |
soundUrl |
指向 .caf 铃声的 HTTPS 链接,最大 6 MB,仅用于这条通知 |
iOS |
level |
active(默认)、passive(无声音和横幅)、timeSensitive(在允许时突破专注模式)或 critical(暂不可用) |
全部 |
volume |
关键警报的音量,0 到 1,关键警报开放后可用 | iOS |
消息管理#
| 参数 | 说明 | 平台 |
|---|---|---|
id |
自定义消息 ID。相同 id 的新通知会替换旧通知 |
全部 |
delete |
1 加上 id,从设备上撤回那条通知 |
全部 |
ttl |
消息在历史记录中保留的秒数。0 表示不保存 |
全部 |
isArchive |
0 表示这条消息不存入历史记录;1 表示即使关闭了保存也存入 |
iOS |
collapse_id |
合并值相同的待投递通知,最多 64 字节 | 全部 |
这些参数如何配合使用,见 更新与撤回。
加密与过滤#
| 参数 | 说明 | 平台 |
|---|---|---|
ciphertext |
加密后的参数。见 推送加密 | iOS |
iv |
ciphertext 的 IV,与 App 中保存的不同时才需要 |
iOS |
filter_criteria |
Breeze 专注模式过滤器使用的名称,例如 work |
iOS |
别名#
Breeze 也接受以下更长的名称。两种写法同时出现时,以 Bark 名称为准。
| 名称 | 等同于 |
|---|---|
message |
body |
thread_id |
group |
open_url |
url |
image_url / icon_url |
image / icon |
sound_url |
soundUrl |
interruption_level |
level;也可写 time-sensitive |
Android 遇到无法支持的参数会返回 HTTP 422,而不是静默忽略。expiration_date、priority、data 和 Apple 原始 payload 等进阶字段见 API 参考。