消息中心接口（pub 域）¶

📄 创建: ZCode AI 2026-08-14 · 修改: JimWb 2026-08-14

https://doc.xpku.com/raw/tech/backend/api-standards/biz-api/pub-message.md

bams-apex 消息中心的 28 个 Controller。全部继承 EnergyBaseController（标准 21 个 CRUD 接口），其中 25 个无自定义方法，仅 3 个有扩展接口。

📖 标准 CRUD 接口的参数/响应格式见 标准CRUD接口规范，本文只列各模块的路径前缀和自定义接口。

⚠️ 重要说明（先读）¶

1. 本域没有"发送动作"接口：发消息/发短信/发邮件是配置表的 CRUD（消息模板/渠道/发送配置），实际发送由 service 层内部（定时任务/业务触发）完成，不通过 REST 接口暴露。
2. 没有序列号生成接口：PubSequenceController 仅提供序列号配置的 CRUD（查/改当前值），生成逻辑在后端 saveOrUpdateExt 内部自动触发。
3. 没有验证码发送/校验接口：PubSmsCodeController 仅提供验证码记录的 CRUD，且需要登录（无免登录）。
4. pub 域没有免登录接口（无 @IgnoreSession）。

一、有自定义接口的模块（3 个）¶

1. 消息主题模板 /pub/msgTemplate¶

@Tag：消息主题模板。类级 @CommonData（跨上级查数据）。

实体 PubMsgTemplate 关键字段：

POST /pub/msgTemplate/listSysOrUmsp — 查询模板列表（本地或 UMSP 透传）¶

查询消息模板分页列表。读取系统配置 umsp.isUmspSendMessage： - true：转发到 UMSP 平台（{umsp.url}/gateway/msg/msgTemplate/getViewList，带 Authorization/accountid 头），返回映射为 PubMsgTemplate（id/templateCode/templateName） - false（默认）：走本地分页查询

{
  "current": 1,
  "size": 10,
  "andMap": { "template_type": "SMS" }
}

• 响应：JsonResult<Page<PubMsgTemplate>>

2. 站内信消息 /pub/notifyMessage¶

@Tag：站内信消息表。待办/接收消息查询用标准 /list（按 andMap 的 userId + confirmStatus/readStatus 过滤）。

实体 PubNotifyMessage 关键字段：

POST /pub/notifyMessage/confirmNotifyMessage — 弹窗消息确认¶

确认处理站内信弹窗消息。命中后置 confirm_status=CONFIRMED、写确认时间，并同步刷新 Redis 弹窗缓存。

请求参数（二选一定位方式）：

// 方式A：按 id
{ "id": "消息id" }

// 方式B：按 redisKey + userId + refId
{ "redis_key": "缓存key", "user_id": "用户id", "ref_id": "业务系统id" }

• 响应：JsonResult<PubNotifyMessage>（data 为空，仅看 code）

3. 版本号采集 /pub/versionInfo¶

@Tag：8000-版本号采集管理。pub 域唯一支持 /tree 树形接口的实体。

实体 PubVersionInfo 关键字段：app_name / app_code / version_desc / deploy_url（部署URL，采集入口）/ build_time / current_version（当前版本号）/ status（0正常/1停用）/ parent_id / app_class（分类）/ sort_num

GET /pub/versionInfo/refresh — 手动触发全量版本采集¶

查询所有配置了 deployUrl 且 status=0 的应用，逐个访问其 deployUrl 采集版本信息并更新版本号表。

• 请求参数：无
• 响应：JsonResult<Map<String,Object>>（data 含扫描统计）

POST /pub/versionInfo/list — 分页查询（重写）¶

重写基类 list，路径/参数/返回与标准 /list 完全一致，前端按标准用法调用即可。

二、仅标准 CRUD 的模块（25 个）¶

以下模块只有标准 21 个接口（见 标准CRUD接口规范），完整 URL = /apex-api + 前缀 + 标准路径。

消息配置类¶

渠道配置类¶

日志查询类¶

公告与配置类¶

三、典型调用示例¶

查询我的未读站内信¶

POST /apex-api/pub/notifyMessage/list
{
  "current": 1,
  "size": 20,
  "andMap": { "user_id": "当前用户id", "read_status": 0 },
  "orderBy": { "created_time": "desc" }
}

确认弹窗消息¶

POST /apex-api/pub/notifyMessage/confirmNotifyMessage
{ "id": "xxxx" }

查询启用的短信模板¶

POST /apex-api/pub/msgTemplate/list
{
  "andMap": { "template_type": "SMS", "enable_state": 2 }
}

相关文档¶

• 标准CRUD接口规范 — 21 个标准接口的参数/响应格式
• 业务中台接口首页