Appearance
消息详情接口
概述
用于查询指定消息详情,并在查询成功后将该消息标记为已读。
- 接口名称:消息详情
- 接口用途:查询消息详情并标记已读
- 调用方:小程序前端
- 请求方式:
GET - 请求路径:
/messages/{messageId} - 请求头要求:个人系统消息需携带
Authorization
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| messageId | path string | 是 | 消息 ID |
返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| messageId | string | 消息 ID |
| title | string | 标题 |
| content | string | 正文 |
| relatedBiz | object | 关联业务 |
relatedBiz 说明
| 参数 | 类型 | 说明 |
|---|---|---|
| bizType | string | 业务类型,如 lottery |
| bizId | string | 业务 ID |
成功示例
{"code":"0","message":"ok","data":{"messageId":"m_1","title":"中奖通知","content":"请联系客服领取","relatedBiz":{"bizType":"lottery","bizId":"lr_1"}}}
失败示例
错误码
| 错误码 | 说明 |
|---|---|
| A0001 | 见系统统一错误码定义 |
| A0002 | 无权限查看该消息 |
接口约束
- 幂等要求:否
- 前后端同步规则:查询成功即标记已读,并回刷未读数
- 缓存/刷新策略:不缓存
- 一致性要求:强一致
实现说明
该接口具有读取与状态变更的复合语义:
- 查询消息详情
- 查询成功后将消息标记为已读
- 前端需同步刷新未读消息数
由于要求强一致且不缓存,前后端应以实时接口返回结果为准。
