查询站内信消息

路径 /industry/message/letter/query
版本号 1.0.2
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 可选
超时时间 6000

请求参数

名称 类型 是否必选 示例值 描述
pageNo Int 起始页,从1开始
pageSize Int 每页大小
msgStatus String unread 收取消息的状态,参数说明 all: 全部,unread:未读,read:已读
appId String appId,用于多租户sass区分
employeeId String 调用者身份id

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

totalCount Long

消息总条数

unreadCount Long

消息未读条数

pageNo Int

当前页码

pageSize Int

每页大小

letterList JSON

报警消息列表

letterId String

这一条消息的唯一id

title String

消息的标题

content String

消息的内容

hasRead Boolean

该消息是否已读

gmtCreate String

消息触发时间

taskId String

任务ID

unreadToRead Boolean

是否是未读到已读

revoked Boolean

消息是否已经撤回

from JSON

消息来源说明

identityId String

发送者的身份ID

name String

发送者的名字

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.2"
	},
	"params":{
		"pageNo": "value0",
		"pageSize": "value1",
		"msgStatus": "unread",
		"appId": "value3",
		"employeeId": "value4"
	}
}

正常返回示例

JSON 格式

{
	"code": 200,
	"data": {
		"pageNo": 1,
		"unreadCount": 16,
		"pageSize": 2,
		"totalCount": 28,
		"letterList": [{
			"unreadToRead": false,
			"letterId": "1000000000000248309",
			"hasRead": false,
			"from": {
				"identityId": "5007al87ea9470a405a10a8312bd45a840931199",
				"name": "zxtest002"
			},
			"title": "this is a test letter",
			"gmtCreate": "1554188945000",
			"content": "test"
		}, {
			"unreadToRead": false,
			"letterId": "1000000000000248308",
			"hasRead": false,
			"from": {
				"identityId": "5007al87ea9470a405a10a8312bd45a840931199",
				"name": "zxtest002"
			},
			"title": "this is a test letter",
			"gmtCreate": "1554188811000",
			"content": "test"
		}]
	},
	"id": "b975029f3b4e44c1bc5cb26da1abd65c"
}

异常返回示例

JSON 格式

{
	"code": 460,
	"message": "request parameter error.",
	"localizedMsg": "请求参数错误",
	"data": null
}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error