调用该接口查询事件列表。
路径 | /vision/customer/event/query |
版本号 | 2.1.3 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotIds | List | 是 | ["QIuozfUcxRX6frOTO4dKz2*****", "cvgIDouK5w6wA3pfcBLcz2****"] | 设备ID列表。设备ID是生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
beginTime | Long | 是 | 1595562249 | 查询开始时间。单位:毫秒。 |
endTime | Long | 是 | 1595582259 | 查询结束时间。单位:毫秒。 |
eventType | Int | 否 | 0 | 事件类型。0(表示全部);1(表示移动侦测);2(表示声音侦测);3(表示人形侦测)。 |
pictureType | Int | 否 | 0 | 图片URL类型。0(表示全部);1(表示原图);2(表示缩略图)。 |
pageStart | Int | 否 | 0 | 从0开始的起始页数。 |
pageSize | Int | 否 | 20 | 分页大小,默认值是20,最大100。 |
needAlarmPicture | Boolean | 否 | true | 是否需要事件关联的图片。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应的结果。 |
|
eventList | JSON |
事件列表。 |
|
eventId | String |
事件ID。若有生效的事件联动录像计划,则可根据事件ID来获取云存计划录像播放地址。 |
|
eventTime | String |
事件发生时间,格式为yyyy-MM-ss HH:mm:ss。 |
|
eventTimeUTC | String |
事件发生UTC时间,格式为yyyy-MM-ssTHH:mm:ssZ。 |
|
eventType | Int |
事件类型。0(表示全部);1 (表示移动侦测)。 |
|
eventDesc | String |
事件的描述。 |
|
eventPicId | String |
事件关联图片ID。 |
|
eventData | String |
事件的附加信息。 |
|
eventPicUrl | String |
报警事件图片链接。 |
|
eventPicThumbUrl | String |
报警事件图片缩率图链接。 |
|
intelligentTypeList | String |
智能事件列表。 |
|
nextValid | Boolean |
下一页是否有效。 |
|
nextBeginTime | Long |
下一页起始时间。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "2.1.3",
"iotToken": "token"
},
"params":{
"iotIds":[
"QIuozfUcxRX6frOTO4dKz2*****",
"cvgIDouK5w6wA3pfcBLcz2****"
],
"beginTime":1595562249,
"endTime":1595582259,
"eventType":0,
"pictureType":0,
"pageStart":0,
"pageSize":20,
"needAlarmPicture":true
}
}
正常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code":200,
"message":"success",
"localizedMsg": "请求成功",
"data":{
"nextValid":true,
"nextBeginTime":1574740948000,
"eventList":[{
"eventId":"111",
"eventTime":"2019-10-10 00:00:00",
"eventTimeUTC":"2019-10-09 20:00:00",
"eventType":1,
"eventDesc":"移动侦测",
"eventPicId":"aaa",
"eventData":"{}",
"eventPicUrl":"https://a****f",
"eventPicThumbUrl":"https://a****f",
"intelligentTypeList":"1"
}]
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
在文档使用中是否遇到以下问题
更多建议
匿名提交