更新时间:2025-07-29 GMT+08:00
分享

查询消息

功能介绍

查询消息信息。

URI

GET /unifiedportal/public/api/v1/messages

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

JWTToken

表2 路径参数

参数

是否必选

参数类型

描述

readFlag

Integer

查询已读(1)/未读消息(0), 不传时查询所有

messageType

String

消息类型, 不传时查询全部类型

fromSysId

List<String>

来源系统ID, 多个以英文逗号分隔, 不传时查询所有

sendTimeB

LocalDateTime

消息发送时间段-开始时间

sendTimeE

LocalDateTime

消息发送时间段-结束时间

请求示例

GET /unifiedportal/v1/portal/messagecenter/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

消息类型

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
}

错误码

请参见错误码

相关文档