Skip to content

1. 获取消息列表

接口地址: /merchantapi/user/message/list

请求方式: POST

请求参数:

参数名类型必填说明
statusint状态:0=未读,1=已读
msg_typeint消息类型:1=我的消息,2=提现消息,3=结算通知,4=官方公告。0=所有消息
pageint页码
limitint每页数量

响应示例:

json
{
  "code": 1,
  "msg": "获取成功",
  "data": {
    "list": [
      {
        "id": 1,
        "content": "您有新的订单",
        "msg_type": 1,
        "status": 0,
        "create_time": 1699999999
      }
    ],
    "count": 50
  }
}

2. 获取所有未读消息数量(详细的可用接口3)

接口地址: /merchantapi/user/message/unReadCount

响应示例:

json
{
  "code": 1,
  "msg": "获取成功",
  "data": 10  //未读消息数量
}

3. 获取未读消息数量

接口地址: /merchantapi/user/message/unReadCountAll

响应示例:

json
{
  "code": 1,
  "msg": "获取成功",
  "data": {
    "totalCount": 10,
    "myMessageCount": 5,
    "withdrawalMessageCount": 2,
    "settlementNoticeCount": 2,
    "officialAnnouncementCount": 1
  }
}

字段说明:

  • totalCount: 总未读数
  • myMessageCount: 我的消息未读数
  • withdrawalMessageCount: 提现消息未读数
  • settlementNoticeCount: 结算通知未读数
  • officialAnnouncementCount: 官方公告未读数

4. 标记已读

接口地址: /merchantapi/user/message/read

请求方式: POST

请求参数:

参数名类型必填说明
idint消息ID

响应示例:

json
{
  "code": 1,
  "msg": "操作成功"
}

5. 标记全部已读

接口地址: /merchantapi/user/message/readAll

响应示例:

json
{
  "code": 1,
  "msg": "操作成功"
}

6. 删除消息

接口地址: /merchantapi/user/message/del

请求方式: POST

请求参数:

参数名类型必填说明
idint消息ID

响应示例:

json
{
  "code": 1,
  "msg": "操作成功"
}

消息订阅

  • 支持push消息订阅,使用websocket订阅频道,接收消息
  • 频道:
    1. 站内消息 private-group-user-message-
    2. 投诉消息 private-group-order-complaint-

详细用例请参考演示站项目:

  • vue/src/utils/websocket/index.ts
  • vue/src/utils/websocket/push.js (文件为框架官方提供,做了稍微适配,建议直接复制使用)