Explorar o código

docs: add detailed instructions for push API fields (#42)

JustSong %!s(int64=2) %!d(string=hai) anos
pai
achega
54d1edaf1b
Modificáronse 1 ficheiros con 13 adicións e 11 borrados
  1. 13 11
      README.md

+ 13 - 11
README.md

@@ -50,6 +50,7 @@ _✨ 搭建专属于你的消息推送服务,支持多种消息推送方式,
    + Bark App,
    + WebSocket 客户端([官方客户端](https://github.com/songquanpeng/personal-assistant),[接入文档](./docs/API.md#websocket-客户端)),
    + Telegram 机器人,
+   + Discord 群机器人(WIP),
 2. 多种用户登录注册方式:
    + 邮箱登录注册以及通过邮箱进行密码重置。
    + [GitHub 开放授权](https://github.com/settings/applications/new)。
@@ -151,18 +152,19 @@ proxy_send_timeout 300s;
    2. `description`:必填,可以替换为 `desp`。
    3. `content`:选填,受限于具体的消息推送方式,Markdown 语法的支持有所区别。
    4. `channel`:选填,如果不填则系统使用你在后台设置的默认推送方式。可选的推送方式有:
-      1. `email`:通过发送邮件的方式进行推送。
-      2. `test`:通过微信测试号进行推送。
-      3. `corp_app`:通过企业微信应用号进行推送。
-      4. `corp`:通过企业微信群机器人推送。
-      5. `lark`:通过飞书群机器人进行推送。
-      6. `ding`:通过钉钉群机器人进行推送。
-      7. `bark`:通过 Bark 进行推送。
-      8. `client`:通过 WebSocket 客户端进行推送。
-      9. `telegram`:通过 Telegram 机器人进行推送(`description` 或 `content` 字段均可,支持 Markdown 的子集)。
-      10. `none`:仅保存到数据库,不做推送。
+      1. `email`:通过发送邮件的方式进行推送(使用 `title` 或 `description` 字段设置邮件主题,使用 `content` 字段设置正文,支持完整的 Markdown 语法)。
+      2. `test`:通过微信测试号进行推送(使用 `description` 字段设置模板消息内容,不支持 Markdown)。
+      3. `corp_app`:通过企业微信应用号进行推送(仅当使用企业微信 APP 时,如果设置了 `content` 字段,`title` 和 `description` 字段会被忽略;使用微信中的企业微信插件时正常)。
+      4. `corp`:通过企业微信群机器人推送(设置 `content` 字段则将渲染 Markdown 消息,支持 Markdown 的子集;设置 `description` 字段则为普通文本消息)。
+      5. `lark`:通过飞书群机器人进行推送(注意事项同上)。
+      6. `ding`:通过钉钉群机器人进行推送(注意事项同上)。
+      7. `bark`:通过 Bark 进行推送(支持 `title` 和 `description` 字段)。
+      8. `client`:通过 WebSocket 客户端进行推送(支持 `title` 和 `description` 字段)。
+      9. `telegram`:通过 Telegram 机器人进行推送(`description` 或 `content` 字段二选一,支持 Markdown 的子集)。
+      10. `discord`:通过 Discord 群机器人进行推送(注意事项同上)。
+      11. `none`:仅保存到数据库,不做推送。
    5. `token`:如果你在后台设置了推送 token,则此项必填。另外可以通过设置 HTTP `Authorization` 头部设置此项。
-   6. `url`:选填,如果不填则系统自动为消息生成 URL。
+   6. `url`:选填,如果不填则系统自动为消息生成 URL,其内容为消息详情
 3. `POST` 请求方式:字段与上面 `GET` 请求方式保持一致。
    + 注意:请求体编码格式为 `application/json`,`v0.3.2` 版本起支持 Post Form。