Bark/docs/tutorial.md
2025-07-30 14:50:10 +08:00

4.9 KiB
Raw Blame History

发送推送

  1. 打开APP复制测试URL
  1. 修改内容请求这个URL。
    可以发 GET 或者 POST 请求 ,请求成功会立即收到推送

URL格式

URL由推送key、参数 title、参数 subtitle、参数 body 组成。有下面三种组合方式

/:key/:body 
/:key/:title/:body 
/:key/:title/:subtitle/:body 

请求方式

GET 请求参数拼接在 URL 后面,例如:
curl https://api.day.app/your_key/推送内容?group=分组&copy=复制

手动拼接参数到URL上时请注意URL编码问题可以参考阅读常见问题URL编码

POST 请求参数放在请求体中,例如:
curl -X POST https://api.day.app/your_key \
     -d'body=推送内容&group=分组&copy=复制'
POST 请求支持JSON例如
curl -X "POST" "https://api.day.app/your_key" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "body": "Test Bark Server",
  "title": "Test Title",
  "badge": 1,
  "sound": "minuet",
  "icon": "https://day.app/assets/images/avatar.jpg",
  "group": "test",
  "url": "https://mritd.com"
}'
JSON 请求 key 可以放进请求体中,URL 路径须为 /push例如
curl -X "POST" "https://api.day.app/push" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "body": "Test Bark Server",
  "title": "Test Title",
  "device_key": "your_key"
}'

请求参数

支持的参数列表具体效果可在APP内预览。

参数 说明
title 推送标题
subtitle 推送副标题
body 推送内容
device_key 设备key
device_keys key 数组,用于批量推送
level 推送中断级别。
critical: 重要警告, 在静音模式下也会响铃
active默认值系统会立即亮屏显示通知
timeSensitive时效性通知可在专注状态下显示通知。
passive仅将通知添加到通知列表不会亮屏提醒。
volume 重要警告的通知音量取值范围0-10不传默认值为5
badge 推送角标,可以是任意数字
call 传"1"时,通知铃声重复播放
autoCopy 传"1"时, iOS14.5以下自动复制推送内容iOS14.5以上需手动长按推送或下拉推送
copy 复制推送时,指定复制的内容,不传此参数将复制整个推送内容。
sound 可以为推送设置不同的铃声
icon 为推送设置自定义图标设置的图标将替换默认Bark图标。
图标会自动缓存在本机,相同的图标 URL 仅下载一次。
group 对消息进行分组推送将按group分组显示在通知中心中。
也可在历史消息列表中选择查看不同的群组。
ciphertext 加密推送的密文
isArchive 传 1 保存推送传其他的不保存推送不传按APP内设置来决定是否保存。
url 点击推送时跳转的URL 支持URL Scheme 和 Universal Link
action 传 "none" 时,点击推送不会弹窗
id 使用相同的ID值时将更新对应推送的通知内容
需 Bark v1.5.2, bark-server v2.2.5 以上
delete 传 "1" 时将从系统通知中心和APP内历史记录中删除通知需搭配 id 参数使用
需在设置里开启”后台App刷新“否则无效。

Bark 支持的应用程序和插件

  • SmsForwarder 监控 Android 手机短信、来电、APP通知并根据指定规则转发到Bark。
  • acme.sh 从 ZeroSSLLet's Encrypt 等 CA 生成免费的证书。可以使用 Bark 接收 acme.sh cronjob 任务通知。
  • Uptime-Kuma 自托管监控工具, 支持Bark作为告警通道。
  • Apprise 可以给几乎所有平台发送通知支持Bark。
  • [浏览器扩展]https://github.com/ij369/bark-sender 将网页内容发送到手机

快捷指令

Bark 支持快捷指令直接发送推送,以下是当收到交警短信时,忽略静音模式持续响铃提醒用户的自动化示例。

  1. 创建个人自动化
  2. 选择信息、填写信息包含关键词触发自动化,选择立即执行,点击下一步
  3. 选择新建空白自动化,选择 Bark 发送推送到此设备快捷指令
  4. 填写推送配置,标题可以选择短信发件人、内容可以选择短信内容,或自己自定义。