调用该接口根据事件ID获取云存录像文件播放地址,需要设备提前配置了生效的事件联动录像计划。

路径 /vision/customer/vod/getbyeventid
版本号 2.1.1
协议 HTTP,HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
iotId String QIuozfUcxfrOTO4dKz2****RX6 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。
eventId String 585682530469d8cc7ee716b9a****_1595561720701 事件的ID。生活物联网平台赋予事件的唯一标识符。
needProlongOriginRecord Boolean true 是否需要延长的事件录像。false(表示云端返回30秒内的事件录像);true(表示云端返回延长的事件录像)。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应的结果。

vodList JSON

播放列表。

fileName String

文件名称。

vodUrl String

播放地址。

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。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "2.1.1",
		"iotToken": "token"
	},
	"params":{
		"iotId": "QIuozfUcxfrOTO4dKz2****RX6",
		"eventId": "585682530469d8cc7ee716b9a****_1595561720701",
		"needProlongOriginRecord":true
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "vodList": [
            {
                "fileName": "",
                "vodUrl": "",
                "beginTime": "",
                "endTime": "",
                "beginTimeUtc": "",
                "endTimeUtc": ""
            }
        ]
    }
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}