文档

接收报警消息列表

更新时间:
一键部署

接收报警消息列表

路径

/industry/message/alarm/query

版本号

1.0.2

协议

HTTPS

请求方法

POST

是否需要用户身份鉴权

可选

超时时间

8000

请求参数

名称

类型

是否必选

示例值

描述

pageNo

Int

起始页,从1开始

pageSize

Int

每页大小

msgStatus

String

unread

收取消息的状态,参数说明 all:全部,unread:未读,read:已读

appId

String

sass应用的appId

employeeId

String

调用者的身份Id

返回数据

名称

类型

示例值

描述

code

Int

响应码, 200: 成功

message

String

错误消息

localizedMsg

String

本地语言错误消息

data

JSON

响应结果

totalCount

Long

报警消息总条数

pageNo

Int

当前页码

pageSize

Int

每页大小

letterList

JSON

报警消息列表

letterId

String

这一条报警消息的唯一id

title

String

报警消息的标题

content

String

报警消息的内容

hasRead

Boolean

该消息是否已读

alarmId

Int

报警ID

level

Int

报警级别,参数说明:0:提醒 1:故障 2:报警

gmtCreate

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,
    "message":null,
    "localizedMsg":null,
    "data":
    {
        "pageNo":1,
        "unreadCount":2,
        "pageSize":2,
        "totalCount":2,
        "letterList":[
                       {"level":0,
                        "alarmId":0,
                        "letterId":"1000000000000149349",
                        "hasRead":false,
                        "title":"wuzhun test alarm by api2[故障]",
                        "gmtCreate":"1550632945000",
                        "content":"测试报警"
                        },
                        {
                        "level":0,
                        "alarmId":0,
                        "letterId":"1000000000000246087",
                        "hasRead":false,
                        "title":"wuzhun test alarm by api[报警]",
                        "gmtCreate":"1550632895000",
                        "content":"this is content"}
                        ]
}
}

异常返回示例

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

  • 本页导读 (0)
文档反馈