下载中心/接口清单

接口清单

下载原文件

P27 接口清单

前缀 /api/message,统一返回 { code, message, data }。

1 站内信箱

方法路径说明
GET/list消息列表(类型、已读状态、时间范围、分页)
GET/unread-count未读数量(按类型分组)
POST/read标记已读(支持批量 id)
POST/read-all全部已读(按类型可选)
GET/detail消息详情与跳转链接

2 模板管理

方法路径说明
GET/template/list模板列表
POST/template/save新建或更新模板
POST/template/toggle启用或停用
GET/template/history模板版本历史
POST/template/rollback回滚到指定版本
POST/template/preview变量渲染预览

3 订阅与路由

方法路径说明
GET/subscription获取当前账号订阅配置
POST/subscription/save保存订阅(业务域 + 渠道)
GET/channel可用渠道与必达规则
POST/do-not-disturb设置免打扰时段

4 发送与记录

方法路径说明
POST/send内部服务触发发送(需服务间鉴权)
POST/broadcast运营群发(需二次确认令牌)
GET/record/list发送记录(状态、失败原因、重试次数)
POST/record/retry手动重试失败消息

5 约定

  • 内部发送接口只允许服务端调用,需签名与来源白名单。
  • 群发必须带 confirm_token,缺省拒绝。
  • 发送失败三次进入人工处理队列,不在前台自动无限重试。
  • 所有模板变更与群发动作写审计日志。