27 lines
779 B
Markdown
27 lines
779 B
Markdown
|
|
# 消息通知接口字段清单
|
||
|
|
|
||
|
|
## 1. 查询通知列表
|
||
|
|
- 接口路径:`GET /api/user/notifications`
|
||
|
|
- 功能说明:获取当前用户通知列表。
|
||
|
|
|
||
|
|
### 查询参数
|
||
|
|
| 字段 | 类型 | 必填 | 说明 |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| page | number | 否 | 页码 |
|
||
|
|
| pageSize | number | 否 | 每页大小 |
|
||
|
|
| readStatus | string | 否 | 已读/未读 |
|
||
|
|
|
||
|
|
### 返回字段
|
||
|
|
| 字段 | 类型 | 说明 |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| notificationId | string | 通知ID |
|
||
|
|
| title | string | 标题 |
|
||
|
|
| content | string | 内容摘要 |
|
||
|
|
| bizType | string | 业务类型 |
|
||
|
|
| readStatus | string | 已读状态 |
|
||
|
|
| createdAt | string | 创建时间 |
|
||
|
|
|
||
|
|
## 2. 标记已读
|
||
|
|
- 接口路径:`POST /api/user/notifications/{notificationId}/read`
|
||
|
|
- 功能说明:将通知标记为已读。
|