消息模块

获取消息列表

1. 请求链接: /notifications/list

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
pageNo	int	Y	"1"	分页
pageSize	int	N	20	每页返回数

4. 返回参数及示例:

参数	类型	描述
list	object	消息列表
pageNo	int	分页pageNo
pageSize	int	分页pageSize

5. list参数:

参数	类型	描述
id	int	消息ID
data	String	消息内容
createdAt	String	消息创建时间
readAt	String	消息已读时间 0代表未读

{
  "list": [
    {
      "id": "e07da0ed-49ba-45ea-943c-539a388849ec",
      "data": "您的锁：CDBN01_df4a6423,已被删除。",
      "createdAt": 1698989446000,
      "readAt": 1699062944000
    },
    {
      "id": "927f6175-9ba9-4fc5-9c3f-78655ac40c90",
      "data": "您的(CDBN01_df4a6423)，于2023-11-03 09:44:44被开锁。",
      "createdAt": 1698975888000,
      "readAt": 0
    }
  ],
  "pageNo": 1,
  "pageSize": 10
}

标注消息已读

1. 请求链接: /notifications/markAsRead

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
id	String	Y	"389ec86c-fd2c-47c5-887b-b37228ce70b7"	消息ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": null
}

删除单条消息

1. 请求链接: /notifications/delete

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
id	String	Y	"389ec86c-fd2c-47c5-887b-b37228ce70b7"	消息ID

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": null
}

全部标注已读

1. 请求链接: /notifications/markAllAsRead

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
无

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": null
}

删除全部消息

1. 请求链接: /notifications/deleteAll

2. 请求方式: POST

3. 参数说明:

名称	类型	是否必需	示例	描述
无

4. 返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": null
}