Back to Bark

Tutorial

docs/tutorial.md

1.1.45.2 KB
Original Source

发送推送

  1. 打开APP,复制测试URL

  2. 修改内容,请求这个URL。

可以发 GET 或者 POST 请求 ,请求成功会立即收到推送

URL格式

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

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

请求方式

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

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

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

MCP

VS Code:

js
{
  "servers": {
    "bark": {
      "type": "http",
      "url": "https://api.day.app/mcp/{key}"
    }
  }
}

Claude Code:

sh
claude mcp add bark --transport http https://api.day.app/mcp/{key}

或者

js
{
  "mcpServers": {
    "bark": {
      "type": "http",
      "url": "https://api.day.app/mcp/{key}"
    }
  }
}

注意将 url 中的 key 替换成你自己的

请求参数

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

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

Bark 支持的应用程序和插件

  • SmsForwarder 监控 Android 手机短信、来电、APP通知,并根据指定规则转发到Bark。
  • acme.sh 从 ZeroSSL,Let's Encrypt 等 CA 生成免费的证书。可以使用 Bark 接收 acme.sh cronjob 任务通知。
  • Uptime-Kuma 自托管监控工具, 支持Bark作为告警通道。
  • Apprise 可以给几乎所有平台发送通知,支持Bark。
  • 浏览器扩展 将网页内容发送到手机
  • RevenueBell 独立开发者工具,将苹果订阅、续订、购买等收入事件,通过 Bark 推送到你的手机。

快捷指令

Bark 支持使用快捷指令直接发送推送