zhongyouweb/docs/api/modules/23-user-message.md

用户消息中心

本模块共 5 个接口。源文件：api.json。

快速索引

接口名称	方法	路径	用途
消息详情	GET	/gd_dataserver/business/message/detail/{id}	查看后自动标记为已读。返回 data 为 UserMessage 对象，包含 id、msgType、title、content、bizId、createTime。
分页查询我的消息列表	GET	/gd_dataserver/business/message/list	返回 data 为 Page 分页对象。list 中每条记录为 UserMessage 对象，主要字段：id、userId-用户ID、msgType-消息类型(如points_award/hazard_audit/appeal_result)、title-消息标题、content-消息内容、bizId-关联业务ID、isRead-是否已读(0未读/1已读)、createTime-创建时间。
标记消息已读	POST	/gd_dataserver/business/message/read/{id}	将指定消息标记为已读。返回 data 为 null，成功时 code=200。
全部标记已读	POST	/gd_dataserver/business/message/readAll	将当前用户所有未读消息标记为已读。返回 data 为 null，成功时 code=200。
获取未读消息数量	GET	/gd_dataserver/business/message/unread-count	返回 data 为 Long 类型的未读消息数量，如 5。用于APP端消息红点展示。

接口详情

消息详情

• 用途： 查看后自动标记为已读。返回 data 为 UserMessage 对象，包含 id、msgType、title、content、bizId、createTime。
• 请求： GET /gd_dataserver/business/message/detail/{id}
• 鉴权： X-Access-Token（以接口定义为准）
• operationId： detailUsingGET_1

参数：

字段	位置	必填	类型	说明	示例
id	path	是	integer / int64	消息ID	-

响应：

状态码	说明	响应模型
200	OK	/: object<string, object>
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

分页查询我的消息列表

• 用途： 返回 data 为 Page 分页对象。list 中每条记录为 UserMessage 对象，主要字段：id、userId-用户ID、msgType-消息类型(如points_award/hazard_audit/appeal_result)、title-消息标题、content-消息内容、bizId-关联业务ID、isRead-是否已读(0未读/1已读)、createTime-创建时间。
• 请求： GET /gd_dataserver/business/message/list
• 鉴权： X-Access-Token（以接口定义为准）
• operationId： listUsingGET_3

参数：

字段	位置	必填	类型	说明	示例
msgType	query	否	string	消息类型（可选）	-
onlyUnread	query	否	boolean	是否只查未读	-
pageNum	query	否	integer / int32	页码	-
pageSize	query	否	integer / int32	每页数量	-

响应：

状态码	说明	响应模型
200	OK	/: object<string, object>
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

标记消息已读

• 用途： 将指定消息标记为已读。返回 data 为 null，成功时 code=200。
• 请求： POST /gd_dataserver/business/message/read/{id}
• 鉴权： X-Access-Token（以接口定义为准）
• operationId： markReadUsingPOST

参数：

字段	位置	必填	类型	说明	示例
id	path	是	integer / int64	消息ID	-

响应：

状态码	说明	响应模型
200	OK	/: object<string, object>
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

全部标记已读

• 用途： 将当前用户所有未读消息标记为已读。返回 data 为 null，成功时 code=200。
• 请求： POST /gd_dataserver/business/message/readAll
• 鉴权： X-Access-Token（以接口定义为准）
• operationId： markAllReadUsingPOST

参数：

无

响应：

状态码	说明	响应模型
200	OK	/: object<string, object>
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

获取未读消息数量

• 用途： 返回 data 为 Long 类型的未读消息数量，如 5。用于APP端消息红点展示。
• 请求： GET /gd_dataserver/business/message/unread-count
• 鉴权： X-Access-Token（以接口定义为准）
• operationId： unreadCountUsingGET

参数：

无

响应：

状态码	说明	响应模型
200	OK	/: object<string, object>
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-