Appearance
7. 消息中心（Message Center）
为避免客户端频繁请求业务数据库进行数据查询，系统新增 消息中心表，用于同步新增或变更的业务消息（如订单、退单、发货等）。 客户端可通过消息中心接口拉取最新消息并在处理完成后及时删除，实现轻量化的消息同步机制。
⚠️ 重要说明： 消息处理成功后请务必调用【消息删除接口】，否则消息中心的记录将持续累积，影响系统性能。
7.1 消息查询接口
接口描述
根据客户端编码与消息类型，获取当前待处理的业务消息列表。
请求方式与路径
GET /api/v1/msgqueue/getByClientCode
请求参数
| 参数名 | 参数位置 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|---|
| clientCode | requestParam | string | 100 | 是 | 客户端编码 |
| msgType | requestParam | string | 20 | 是 | 消息类型（详见消息类型说明） |
响应参数
| 参数名 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| msgType | string | 2 | 是 | 消息类型 |
| bizCode | string | 100 | 是 | 业务单据编码（如采购单号） |
响应示例
json
[
{"msgType": "310", "bizCode": "2000634729W"},
{"msgType": "310", "bizCode": "2000634727W"}
]7.2 消息删除接口
接口描述
客户端在处理完消息后调用此接口删除对应的消息记录，防止重复推送。
请求方式与路径
POST /api/v1/msgqueue/deleteMessageQueue
请求参数
| 参数名 | 参数位置 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|---|
| clientCode | requestBody | string | 100 | 是 | 客户端编码 |
| msgType | requestBody | string | 20 | 是 | 消息类型（详见消息类型说明） |
| bizCode | requestBody | string | 20 | 是 | 业务单据号（订单编码、商品编码等） |
响应参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| result | boolean | 是 | 是否删除成功（true/false） |
请求示例
json
{
"clientCode": "C123456",
"msgType": "310",
"bizCode": "2000634729W"
}响应示例
json
{
"result": true
}7.3 消息类型说明
| 消息类型 | 描述 |
|---|---|
| 201 | 商品 |
| 300 | 订单取消 |
| 310 | 下单确认 |
| 320 | 订单发货 |
| 330 | 订单签收中 |
| 390 | 订单签收完成 |
| 400 | 退单取消 |
| 410 | 退单确认 |
| 490 | 退单完成 |
| 501 | 结算（未开放） |
| 101 | 基础（未开放） |
✅ 使用建议
- 客户端应定时轮询（建议间隔 ≥30秒）或在服务端推送机制下主动拉取消息。
- 每次获取后应 及时调用删除接口，确保消息表清洁、系统高效。
- 对于未开放的消息类型，可提前做好接口兼容与异常处理。