消息模块

消息鉴权接口文档

概览

• 基础路径: /api
• 文档范围: 鉴权路由中的 message 模块接口
• 鉴权方式: 请求头 X-Token
• Content-Type: application/json

鉴权头

统一响应格式

{
  "code": 200,
  "msg": "操作成功",
  "data": {}
}

消息对象字段说明

1. 获取消息列表

• 路径: /api/message/list
• 方法: POST
• 是否鉴权: 是

请求 Body 参数

请求示例

{
  "type": "feed",
  "page": 1,
  "pageSize": 20
}

成功响应示例

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "list": [
      {
        "userId": 1,
        "type": "feed",
        "title": "喂食成功",
        "content": "设备 dev_001 已完成喂食",
        "read": false,
        "createdAt": "2026-05-09T10:00:00Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 20
  }
}

失败响应示例

{
  "code": 400,
  "msg": "page 参数错误",
  "data": null
}

{
  "code": 400,
  "msg": "pageSize 参数错误",
  "data": null
}

{
  "code": 500,
  "msg": "获取消息列表失败",
  "data": null
}

2. 标记消息已读

• 路径: /api/message/markRead
• 方法: POST
• 是否鉴权: 是

请求 Body 参数

请求示例

{
  "id": 123
}

全部已读：

{}

成功响应示例

{
  "code": 200,
  "msg": "已标记为已读",
  "data": null
}

{
  "code": 200,
  "msg": "已全部标记为已读",
  "data": null
}

失败响应示例

{
  "code": 400,
  "msg": "参数错误",
  "data": null
}

{
  "code": 400,
  "msg": "标记失败",
  "data": null
}

{
  "code": 500,
  "msg": "操作失败",
  "data": null
}

3. 清空消息

• 路径: /api/message/clear
• 方法: POST
• 是否鉴权: 是

请求 Body

无业务参数，可传空对象：

{}

成功响应示例

{
  "code": 200,
  "msg": "消息已清空",
  "data": null
}

失败响应示例

{
  "code": 500,
  "msg": "清空消息失败",
  "data": null
}