Bark/docs/tutorial.md
2024-12-11 18:01:51 +08:00

3.1 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.caf",
  "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 推送内容
level 推送中断级别。
active默认值系统会立即亮屏显示通知
timeSensitive时效性通知可在专注状态下显示通知。
passive仅将通知添加到通知列表不会亮屏提醒。
badge 推送角标,可以是任意数字
autoCopy iOS14.5以下自动复制推送内容iOS14.5以上需手动长按推送或下拉推送
copy 复制推送时,指定复制的内容,不传此参数将复制整个推送内容。
sound 可以为推送设置不同的铃声
call 通知铃声重复播放
icon 为推送设置自定义图标设置的图标将替换默认Bark图标。
图标会自动缓存在本机,相同的图标 URL 仅下载一次。
group 对消息进行分组推送将按group分组显示在通知中心中。
也可在历史消息列表中选择查看不同的群组。
ciphertext 推送加密
level 重要警告、时效性通知、静默通知
volume 重要警告的通知音量,可不传
isArchive 传 1 保存推送传其他的不保存推送不传按APP内设置来决定是否保存。
url 点击推送时跳转的URL 支持URL Scheme 和 Universal Link