1. 接口列表

本节包含设备告警消息查询相关接口等。

接口列表如下:

序号 接口功能 描述
1 获取所有告警信息列表 查询用户下的所有告警消息列表
2 按照设备获取告警消息列表 查询指定设备的告警消息列表

1.1. 获取所有告警信息列表

  • 接口功能:

    获取账号下的所有告警消息列表

  • 请求地址

    https://open.ys7.com/api/lapp/alarm/list

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
startTime long 告警查询开始时间,时间格式为1457420564508,精确到毫秒,默认为今日0点,最多查询当前时间7天前以内的数据 N
endTime long 告警查询结束时间,时间格式为1457420771029,精确到毫秒,默认为当前时间 N
alarmType int 告警类型,默认为-1(全部) N
status int 告警消息状态:2-所有,1-已读,0-未读,默认为0(未读状态) N
pageStart int 分页起始页,从0开始,默认为0 N
pageSize int 分页大小,默认为10,最大为50 N
  • HTTP请求报文
POST /api/lapp/alarm/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.47egoa5iazk02hcn73sepv2q12x8ulsx&startTime=&endTime=&alarmType=-1&status=2&pageStart=0&pageSize=3
  • 返回数据
{
    "page":{
        "total":9,
        "page":0,
        "size":3
    },
    "data":[
        {
            "alarmId":"24027912025633491",
            "alarmName":"设备1",
            "alarmType":10000,
            "alarmTime":4364654646485,
            "channelNo":1,
            "isEncrypt":0,
            "isChecked":0,
            "recState":1,
            "preTime":10,
            "delayTime":30,
            "deviceSerial":"427734888",
            "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455866402_724A2B55F5AFe741_06CE56000475452014644?isEncrypted=0&isCloudStored=0",
            "relationAlarms":[

            ],
            "customerType":null,
            "customerInfo":null
        },
        {
            "alarmId":"24027912025633469",
            "alarmName":"设备2",
            "alarmType":10000,
            "alarmTime":4364654646485,
            "channelNo":1,
            "isEncrypt":0,
            "isChecked":0,
            "recState":1,
            "preTime":10,
            "delayTime":30,
            "deviceSerial":"427734777",
            "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455865753_B2B20A0FB4B45da2_06CE56000475437014644?isEncrypted=0&isCloudStored=0",
            "relationAlarms":[

            ],
            "customerType":null,
            "customerInfo":null
        },
        {
            "alarmId":"24027912025633457",
            "alarmName":"设备3",
            "alarmType":10000,
            "alarmTime":4364654646485,
            "channelNo":1,
            "isEncrypt":0,
            "isChecked":0,
            "recState":1,
            "preTime":10,
            "delayTime":30,
            "deviceSerial":"427734666",
            "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455865563_0C0F2D84B18Ead68_06CE56000475431014644?isEncrypted=0&isCloudStored=0",
            "relationAlarms":[

            ],
            "customerType":null,
            "customerInfo":null
        }
    ],
    "code":"200",
    "msg":"操作成功!"
}
  • 返回字段:
字段名 类型 描述
alarmId String 消息ID
alarmName String 告警源名称
alarmType int 告警类型
alarmTime long 告警时间,long格式如12323452345,精确到毫秒
channelNo int 通道号
isEncrypt int 是否加密:0-不加密,1-加密
isChecked int 是否已读:0-未读,1-已读
recState int 存储类型:0-无存储,1-萤石云存储,4-sd卡存储,5-萤石云存储和sd卡存储
preTime int 预录时间:单位秒
delayTime int 延迟录像时间:单位秒
deviceSerial String 设备序列号
alarmPicUrl String 告警图片地址
relationAlarms list 关联的告警消息
customerType String 透传设备参数类型
customerInfo String 透传设备参数内容
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
49999 数据异常 接口调用异常

1.2. 按照设备获取告警消息列表

  • 接口功能

    获取对应设备的告警消息列表

  • 请求地址

    https://open.ys7.com/api/lapp/alarm/device/list

  • 请求方式

    POST

  • 子账户token请求所需最小权限

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号 Y
pageSize int 分页大小,默认为10,最大为,50 N
pageStart int 分页起始页,从0开始 N
startTime long 告警查询开始时间,时间格式为1457420564508,精确到毫秒,默认为今日0点,最多查询当前时间起前推7天以内的数据 N
endTime long 告警查询结束时间,时间格式为1457420771029,默认为当前时间 N
status int 告警消息状态:2-所有,1-已读,0-未读,默认为0(未读状态) N
alarmType int 告警类型,默认为-1(全部) N
  • HTTP请求报文
POST /api/lapp/alarm/device/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.47egoa5iazk02hcn73sepv2q12x8ulsx&deviceSerial=427734888&startTime=&endTime=&alarmType=-1&status=2&pageStart=0&pageSize=3
  • 返回数据
{
    "page":{
        "total":9,
        "page":0,
        "size":3
    },
    "data":[
        {
            "alarmId":"24027912025633491",
            "alarmName":"设备1",
            "alarmType":10000,
            "alarmTime":4364654646485,
            "channelNo":1,
            "isEncrypt":0,
            "isChecked":0,
            "recState":1,
            "preTime":10,
            "delayTime":30,
            "deviceSerial":"427734888",
            "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455866402_724A2B55F5AFe741_06CE56000475452014644?isEncrypted=0&isCloudStored=0",
            "relationAlarms":[

            ],
            "customerType":null,
            "customerInfo":null
        },
        {
            "alarmId":"24027912025633469",
            "alarmName":"设备1",
            "alarmType":10000,
            "alarmTime":4364654646485,
            "channelNo":1,
            "isEncrypt":0,
            "isChecked":0,
            "recState":1,
            "preTime":10,
            "delayTime":30,
            "deviceSerial":"427734888",
            "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455865753_B2B20A0FB4B45da2_06CE56000475437014644?isEncrypted=0&isCloudStored=0",
            "relationAlarms":[

            ],
            "customerType":null,
            "customerInfo":null
        },
        {
            "alarmId":"24027912025633457",
            "alarmName":"设备1",
            "alarmType":10000,
            "alarmTime":4364654646485,
            "channelNo":1,
            "isEncrypt":0,
            "isChecked":0,
            "recState":1,
            "preTime":10,
            "delayTime":30,
            "deviceSerial":"427734888",
            "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455865563_0C0F2D84B18Ead68_06CE56000475431014644?isEncrypted=0&isCloudStored=0",
            "relationAlarms":[

            ],
            "customerType":null,
            "customerInfo":null
        }
    ],
    "code":"200",
    "msg":"操作成功!"
}
  • 返回字段:
字段名 类型 描述
alarmId String 消息ID
alarmName String 告警源名称
alarmType int 告警类型
alarmTime long 告警时间,long格式如12323452345,精确到毫秒
channelNo int 通道号
isEncrypt int 是否加密:0-不加密,1-加密
isChecked int 是否已读:0-未读,1-已读
recState int 存储类型:0-无存储,1-萤石云存储,4-sd卡存储,5-萤石云存储和sd卡存储
preTime int 预录时间:单位秒
delayTime int 延迟录像时间,单位秒
deviceSerial String 设备序列号
alarmPicUrl String 告警图片地址
relationAlarms list 关联的告警消息
customerType String 透传设备参数类型
customerInfo String 透传设备参数内容
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常

results matching ""

    No results matching ""