调用该接口查询时间范围内的云端录像文件列表,支持分页查询。可通过查出列表项中的filename来获取播放地址。
路径 | /vision/customer/record/query |
版本号 | 2.1.3 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 | |
streamType | Int | 否 | 码流信息。0(表示主码流);1(表示辅码流)。 | |
beginTime | Int | 是 | 查询开始的时间。单位:秒。 | |
endTime | Int | 是 | 查询结束的时间。单位:秒。 | |
recordType | Int | 否 | 录像类型。0(表示计划录像);1(表示报警录像);2(表示主动录像);99(表示查询所有类型)。 | |
pageStart | Int | 否 | 从0开始的起始页数。 | |
pageSize | Int | 否 | 分页大小,取值范围:1~500。 | |
needSnapshot | Boolean | 否 | 是否需要录像缩略图。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应结果。 |
|
recordFileList | JSON |
云端录像文件列表。 |
|
beginTime | String |
文件开始时间,格式为yyyy-MM-dd HH:mm:ss。 |
|
endTime | String |
文件结束时间,格式为yyyy-MM-dd HH:mm:ss。 |
|
beginTimeUTC | String |
文件开始的UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
|
endTimeUTC | String |
文件结束的UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
|
recordType | Int |
录像类型。0(表示计划录像);1(表示报警录像);2(表示主动录像);3(表示边看边录)。 |
|
streamType | Int |
码流信息。0(表示主码流);1(表示辅码流)。 |
|
fileName | String |
文件的名称。 |
|
fileSize | Int |
文件的大小。 |
|
snapshotUrl | String |
录像缩略图的链接。 |
|
intelligentTypeList | String |
智能事件列表。 |
|
nextValid | Boolean |
下一页是否有效。 |
|
nextBeginTime | Int |
下一页起始时间。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "2.1.3",
"iotToken": "token"
},
"params":{
"iotId": "value0",
"streamType": "value1",
"beginTime": "value2",
"endTime": "value3",
"recordType": "value4",
"pageStart": "value5",
"pageSize": "value6",
"needSnapshot": "value7"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"nextValid":true,
"nextBeginTime":12345,
"recordFileList":[
{
"fileName":"9322443e-0711-427b-9dd2-8035d9fed1c7",
"streamType":0,
"fileSize":11725560,
"recordType":2,
"intelligentTypeList":"3",
"beginTime":"2019-08-23 14:43:45",
"endTime":"2019-08-23 14:45:44",
"beginTimeUTC":"2019-08-23T6:43:45Z",
"endTime":"2019-08-23T6:45:44Z",
"snapshotUrl":"https://xxxx"
}
]
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}