调用该接口配置录像计划,在计划时间范围内则通知设备推流。云存录像单个文件长度不超过30分钟,需要与设备绑定后才计划才会生效。
路径 | /vision/customer/record/plan/set |
版本号 | 2.1.0 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
name | String | 是 | 录像计划的名称。 | |
allDay | Int | 是 | 是否全天。0(表示非全天);1(表示全天)。如果设置了allDay为1,且同时设置了timeSectionList,则以AllDay为准。 | |
timeSectionList | List | 是 | 非全天时间信息列表。包含以下子参数:dayOfWeek(周日到周六,0代表周日,6代表周六)、begin(每天开始时间,单位秒,范围0-86399)、end(每天结束时间,单位秒,范围0-86399)。 | |
dayOfWeek | Int | 是 | 周日到周六。0(表示周日);6(表示周六)。 | |
begin | Int | 是 | 每天开始时间。范围:0秒~86399秒。 | |
end | Int | 是 | 每天结束时间。范围:0秒-86399秒。 | |
timeZone | Int | 否 | 8 | UTC时区,取值区间:-11~12。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应结果。 |
|
planId | String |
录像计划ID。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "2.1.0",
"iotToken": "token"
},
"params":{
"name": "value0",
"allDay": "value1",
"timeSectionList": "value2",
"timeZone":8
}
}
正常返回示例
JSON
格式
{
"code": 200,
"data": {
"planId": "afe463357fbc408789fe20da3ca6****"
},
"message": "success"
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}