调用该接口根据批量事件的ID查询事件列表。
路径 | /vision/customer/event/query/byeventids |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | QIuozfUcxRX6frOTO4dKz2**** | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
eventIds | List | 是 | ["03872c3f221c47041251645c****_1595562311395"] | 事件ID列表。事件ID是生活物联网平台赋予事件的唯一标识符。 |
needAlarmPicture | Boolean | 否 | true | 是否查询事件对应告警的图片。false(表示云端不返回事件的图片信息);true(表示云端返回事件的图片信息)。 |
needRecordSnapshot | Boolean | 否 | false | 是否查询事件对应的录像缩略图。false(表示云端不返回事件录像的缩略图);true(表示云端返回事件录像的缩略图)。 |
needProlongOriginRecord | Boolean | 否 | false | 是否需要延长的事件录像。false(表示云端返回30秒内的事件录像);true(表示云端返回延长的事件录像)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应的结果。 |
|
eventList | JSON |
事件列表。 |
|
eventTime | String |
事件时间。 |
|
eventTimeUTC | String |
事件的UTC时间。 |
|
eventId | String |
事件的ID。是生活物联网平台赋予事件的唯一标识符。 |
|
eventType | Int |
事件的类型。 |
|
eventPicId | String |
事件对应的图片ID。 |
|
eventFileName | String |
事件对应的录像文件名。 |
|
eventPicUrl | String |
事件对应的告警图片链接。 |
|
eventPicThumbUrl | String |
事件对应的告警图片缩略图链接。 |
|
recordSnapshotUrl | String |
事件对应的录像缩略图。 |
|
eventData | String |
事件的附加信息。 |
|
eventDesc | String |
事件的描述。 |
|
intelligentTypeList | String |
智能事件列表。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1",
"iotToken": "token"
},
"params":{
"iotId": "QIuozfUcxRX6frOTO4dKz2****",
"eventIds":[
"03872c3f221c47041251645c****_1595562311395"
],
"needAlarmPicture":true,
"needRecordSnapshot":false,
"needProlongOriginRecord":false
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"eventList": [{
"eventId": "12345",
"eventTime": "2020-03-10 09:00:00",
"eventTimeUTC": "2020-03-10T01:00:00Z",
"eventType": 0,
"eventPicId": "agagg",
"eventFileName": "1123eeee",
"eventPicUrl": "https://xxx",
"eventPicThumbUrl": "https://xxxx",
"recordSnapshotUrl": "https://xxxx",
"eventData": "data",
"eventDesc": "desc",
"intelligentTypeList": ""
}],
"nextValid": true,
"nextBeginTime": 123123123
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}