查看消息列表

接口说明

支持查看消息管理列表,字段包含:消息ID、消息主题、消息创建时间、发送时间、发送状态、目标用户数、已阅用户数。 限流:根据租户实现用户级别的限流,限制为100次每秒


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/message/list

请求参数

Body

参数名称
类型
必填
描述
messageManageListReq
MessageManageListOpenapiReq
是

查看消息列表请求入参

subject
string
否

消息主题

mode
integer(int32)
否

查看方式: 0静默消息,1强制消息

status
integer(int32)
否

发送状态: 0:待发送,1:已发送,2:已撤回

sendBeginTime
string
否

发送开始时间

sendEndTime
string
否

发送结束时间

createdBeginTime
string
否

创建开始时间

createdEndTime
string
否

创建结束时间

currentPage
integer(int32)
否

当前页

pageSize
integer(int32)
否

分页大小

请求示例

POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/message/list
{
	"currentPage":1,
	"pageSize":10
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
PageReturnEntity«MessageManageOpenapiResp»

请求成功时返回的数据

data
<MessageManageOpenapiResp> array

数据

allUser
integer(int32)

目标用户数

createdTime
string

创建时间

messageId
string

消息ID(UUID)

readUser
integer(int32)

已阅用户数

sendTime
string

发送时间

status
integer(int32)

发送状态: 0:待发送,1:已发送,2:已撤回

subject
string

消息主题

totalCount
integer(int32)

总行数

errorCode
string

统一错误码

errorMessage
string

错误码提示信息

requestId
string

每个请求的序列号

state
enum(OK,ERROR,EXCEPTION,FORBIDDEN,REMAINING,TIMEOUT)

返回状态码;返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN

返回示例

返回码:200
OK
{
	"state":"OK",
	"body":{
		"data":[
			{
				"messageId":"35d9a2ac40c74d5b836e4872b3a21ea7",
				"subject":"客户端登录",
				"createdTime":"2024-11-16 13:16:12",
				"sendTime":"2024-11-16 13:16:13",
				"status":1,
				"allUser":1,
				"readUser":0
			},
			{
				"messageId":"0096b84b322440b98a1bb564b753bb97",
				"subject":"客户端登录",
				"createdTime":"2024-11-16 13:14:51",
				"sendTime":"2024-11-16 13:14:52",
				"status":1,
				"allUser":1,
				"readUser":0
			},
			{
				"messageId":"75a09bb2e52e4f86908df3052a9543ac",
				"subject":"云电脑到期冻结消息",
				"createdTime":"2024-11-16 12:40:26",
				"sendTime":"2024-11-16 12:40:27",
				"status":1,
				"allUser":1,
				"readUser":0
			},
			{
				"messageId":"64a5bd2b1bca456e8b9b5480b9f16b28",
				"subject":"云电脑到期冻结消息",
				"createdTime":"2024-11-16 12:40:26",
				"sendTime":"2024-11-16 12:40:27",
				"status":1,
				"allUser":1,
				"readUser":0
			},
			{
				"messageId":"ee1c1529fd1c48e8b421155cb9c15dbd",
				"subject":"客户端登录",
				"createdTime":"2024-11-16 12:32:07",
				"sendTime":"2024-11-16 12:32:08",
				"status":1,
				"allUser":1,
				"readUser":0
			},
			{
				"messageId":"d0bf9435359c40968b305e104224d6fd",
				"subject":"客户端登录",
				"createdTime":"2024-11-16 12:17:33",
				"sendTime":"2024-11-16 12:17:34",
				"status":1,
				"allUser":1,
				"readUser":0
			},
			{
				"messageId":"531d4755ab85466e8021e908b32c1d88",
				"subject":"客户端登录",
				"createdTime":"2024-11-16 11:38:54",
				"sendTime":"2024-11-16 11:38:55",
				"status":1,
				"allUser":1,
				"readUser":0
			},
			{
				"messageId":"22b55f1fcf2d4a3ab477950b122203b3",
				"subject":"客户端登录",
				"createdTime":"2024-11-16 11:30:35",
				"sendTime":"2024-11-16 11:30:36",
				"status":1,
				"allUser":2,
				"readUser":0
			},
			{
				"messageId":"fb580d2fc2794abaa1155db7bb4415a2",
				"subject":"客户端登录",
				"createdTime":"2024-11-16 11:26:48",
				"sendTime":"2024-11-16 11:26:49",
				"status":1,
				"allUser":2,
				"readUser":0
			},
			{
				"messageId":"e3f3929580a14fe284e7cb847e6d1ff8",
				"subject":"客户端登录",
				"createdTime":"2024-11-16 11:24:07",
				"sendTime":"2024-11-16 11:24:08",
				"status":1,
				"allUser":1,
				"readUser":0
			}
		],
		"totalCount":26173
	},
	"errorCode":"200",
	"errorMessage":"",
	"requestId":"ecb099029df34b07a8b28359926d6698"
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。