查询消息 - QueryMessage

功能介绍

查询消息信息。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /unifiedportal/public/api/v1/messages

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
Authorization	是	String	JWTToken

表2 路径参数
参数	是否必选	参数类型	描述
readFlag	否	Integer	查询已读(1)/未读消息(0), 不传时查询所有
messageType	否	String	消息类型, 不传时查询全部类型消息类型： APPROVAL_NOTIFICATION审批信息 AUTHORIZATION_NOTIFICATION授权提醒 SYSTEM_NOTIFICATION系统信息
fromSysId	否	List<String>	来源系统ID, 多个以英文逗号分隔, 不传时查询所有
sendTimeB	否	LocalDateTime	消息发送时间段-开始时间
sendTimeE	否	LocalDateTime	消息发送时间段-结束时间

请求示例

GET /unifiedportal/public/api/v1/messages?offset=0&limit=10&readFlag=0

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
error_code	String	返回码
error_msg	String	返回码描述
datas	Array of MessageTemplate	返回数据
totalCount	Long	返回数据总条数
reserve	String	扩展信息

表4 Message
参数	参数类型	描述
messageId	String	消息ID
fromSysId	String	来源系统ID
fromSysName	String	来源系统名称
fromSysLogo	String	来源系统logo
messageSubject	String	消息主题
messageContent	String	消息内容
messageType	String	消息类型： APPROVAL_NOTIFICATION审批信息 AUTHORIZATION_NOTIFICATION授权提醒 SYSTEM_NOTIFICATION系统信息
messageSendTime	LocalDateTime	消息发送时间
createTime	LocalDateTime	消息创建时间
redirectUrl	String	消息跳转地址
readFlag	Integer	消息是否已读
readTime	LocalDateTime	消息阅读时间
userId	String	消息投递的用户

响应示例

{
    "code": "IPDC.01010000",
    "message": "SUCCESS",
    "datas": [
        {
            "messageId": "774954632710459392",
            "fromSysId": "0",
            "fromSysName": "基础服务",
            "fromSysLogo": null,
            "messageSubject": "授权有效期延长通知",
            "messageContent": "组织已为您的工业仿真云平台应用的进行授权续期，授权时间段为2031-03-01 15:15:35~2031-03-01 15:15:35。",
            "messageType": "AUTHORIZATION_NOTIFICATION",
            "messageSendTime": "2025-06-13T11:13:02.363508",
            "createTime": "2025-06-13T11:13:02.399",
            "redirectUrl": null,
            "readFlag": 0,
            "readTime": null,
            "userId": null
        }
    ],
    "totalCount": 1
}