版本 2.4.7.20261116085428 · 最新

消息 messages

站内信与公告;管理员发布公告,租户查看、标记已读。

点击任一接口,右侧显示对应的调用示例。

消息鉴权: 仅管理员7 个接口

鉴权

请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。

X-API-Key

鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。

约定

分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。

时间一律 RFC 3339(UTC);金额单位为分。

写操作成功回 200/201/204;重复提交按资源唯一键回 409。

GET/api/v2/messages列出消息

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
tenant_idsstring 仅管理员可用:只看这些租户,逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用。只做过滤、不切换请求作用域,与 tenant_id 及其他条件取交集;租户凭据带了非空值回 403。
typestring 消息类型,如 announcement、cert-expire。
site_idinteger 网站 ID
site_idsstring 按网站(多个)过滤:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用;与其他条件取交集。
readboolean 已读筛选。false 只要未读(与顶栏铃铛未读数同口径,恒相等,不含公告),true 只要已读(同一范围内);不传不筛。管理员看到的已读状态是管理员自己的。
POST/api/v2/messages发布公告

鉴权: 仅管理员

请求体 application/json

字段类型说明
contentstring 消息正文。公告按白名单净化后保存(段落、标题、加粗、斜体、列表、引用、http(s) 链接),脚本、事件属性、图片、表格被去掉。
is_externalboolean 为真时点击跳 url,url 必填;否则 content 必填。
is_importantboolean 是否标为重要(标题前带「重要」标签)。
is_pinnedboolean 是否置顶。新置顶的排在置顶组最前,组内顺序用 PUT /messages/pin-order 调整。
is_popupboolean 是否弹窗显示。
is_showboolean 是否显示。
sortinteger 置顶组内的排序值(小的在前),只对置顶的公告有意义;置顶时服务端放到组最前,调整顺序用 PUT /messages/pin-order。
title必填string 消息标题。
urlstring is_external 为真时点击跳转的链接。
PUT/api/v2/messages/pin-order置顶公告重排

鉴权: 仅管理员

请求体 application/json

字段类型说明
ids必填integer[] 置顶公告 id,按希望的顺序(前面的排在前)。
POST/api/v2/messages/read标记已读

鉴权: 用户

请求体 application/json

字段类型说明
idsinteger[] 置顶公告 id,按希望的顺序(前面的排在前)。
GET/api/v2/messages/{id}获取消息

鉴权: 用户(部分参数仅管理员)

PUT/api/v2/messages/{id}修改消息

鉴权: 仅管理员

请求体 application/json

字段类型说明
contentstring 消息正文。公告按白名单净化后保存(段落、标题、加粗、斜体、列表、引用、http(s) 链接),脚本、事件属性、图片、表格被去掉。
is_externalboolean 为真时点击跳 url,url 必填;否则 content 必填。
is_importantboolean 是否标为重要(标题前带「重要」标签)。
is_pinnedboolean 是否置顶。新置顶的排在置顶组最前,组内顺序用 PUT /messages/pin-order 调整。
is_popupboolean 是否弹窗显示。
is_showboolean 是否显示。
sortinteger 置顶组内的排序值(小的在前),只对置顶的公告有意义;置顶时服务端放到组最前,调整顺序用 PUT /messages/pin-order。
titlestring 消息标题。
urlstring is_external 为真时点击跳转的链接。

消息对象

字段类型说明
contentstring 消息正文。公告按白名单净化后保存(段落、标题、加粗、斜体、列表、引用、http(s) 链接),脚本、事件属性、图片、表格被去掉。
countinteger 未读消息数。
created_atstring 创建时间
只读
idinteger 记录 ID
只读
ids必填integer[] 置顶公告 id,按希望的顺序(前面的排在前)。
is_externalboolean 为真时点击跳 url,url 必填;否则 content 必填。
is_importantboolean 是否标为重要(标题前带「重要」标签)。
is_pinnedboolean 是否置顶。新置顶的排在置顶组最前,组内顺序用 PUT /messages/pin-order 调整。
is_popupboolean 是否弹窗显示。
is_showboolean 是否显示。
readboolean 是否已读。
只读
read_countinteger 已读的租户数(只数租户,不算管理员自己;管理员接口才带,租户看不到)。
只读
site_idinteger 网站 ID
只读
sortinteger 置顶组内的排序值(小的在前),只对置顶的公告有意义;置顶时服务端放到组最前,调整顺序用 PUT /messages/pin-order。
tenant_idinteger 收件租户;公告为空。
只读
titlestring 消息标题。
title_argsobject 标题键的参数:名字 → 字符串、数字,或子句 {key, args}(子句同样先查词典再填占位,可嵌套)。
只读
title_keystring 标题键(中文原句,{名字} 占位)。有值时面板拿它查界面语言的词典、用 title_args 填占位来显示标题;为空(旧消息、公告、标题被改过)显示 title 原文。
只读
typestring announcement = 公告;其余为通知类型(如 cert-expire、package-expire)。
只读
updated_atstring 更新时间
只读
urlstring is_external 为真时点击跳转的链接。

返回与错误

成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。

成功
{
  "id": 1,
  "name": "example"
}
列表
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
失败
{
  "code": "validation_failed",
  "detail": "请求参数不合法",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name 必填"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
开始使用

123

123