message.md 1.9 KB

消息中心 API 接口文档 (pages/message)

1. 获取消息会话列表

  • 接口说明: 加载消息列表页,支持按全部、已读、未读进行过滤。
  • 请求路径: /message/list
  • 请求方法: GET
  • 公共头部: Authorization: Bearer {Token}
  • 接口参数:
参数名 类型 必填 说明 示例值
type String 过滤类型: all, unread, read "unread"
page Number 页码 1
  • 接口返回 JSON 数据:
字段名 类型 说明 示例值
code Number 状态码 200
data Object 分页包装对象 { ... }
data.list Array 消息对象列表 [ ... ]
data.list[].id Number 消息关联 ID 88
data.list[].title String 消息标题 "投递进度更新"
data.list[].position String 关联岗位名称 "审计项目助理"
data.list[].company String 关联公司名称 "华财仁合"
data.list[].time String 消息时间显示文本 "10:30"
data.list[].is_unread Boolean 是否未读 true
data.list[].summary String 消息摘要内容 "您的简历已通过初筛..."

2. 标记全部已读

  • 接口说明: 一键将当前用户的所有未读消息设为已读状态。
  • 请求路径: /message/read-all
  • 请求方法: POST
  • 公共头部: Authorization: Bearer {Token}
  • 接口返回 JSON 数据:

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

3. 获取全局未读总数

  • 接口说明: 用于 APP 底部 TabBar 的红点数值显示。通常在 App.vue 或全局轮询时调用。
  • 请求路径: /message/unread-count
  • 请求方法: GET
  • 接口返回 JSON 数据:

    {
    "code": 200,
    "data": {
    "count": 5
    }
    }