开启录像计划

接口调用说明

请求地址 : /v1/api/device/record_plan/start
请求方式 : POST

请求头

参数名 参数值 是否必须
Content-Type application/json
X-Token 实际accessToken

请求报文体

名称 类型 是否必须 备注
deviceSn String 设备序列号
channels object [] 通道列表

channels内容如下:

名称 类型 是否必须 备注
channelId int 通道号
streamId int 码流类型,0:高清码流2M,1:标清码流,默认0
recordType String 录像规则:all-全天录像 time-分时段录像,默认all
recordAudio Boolean 是否录制音频,默认true
recordEncryt Boolean 是否加密,默认false
task object 分时段录像配置,recordType="time"必填

task内容如下:

名称 类型 是否必须 备注
time object [] 时间配置

time内容如下:

名称 类型 是否必须 备注
week String 日期
beginTime String 开始时分秒(格式:HHmmss)
endTime String 结束时分秒(格式:HHmmss)

week 枚举:

枚举值 说明
Mon 星期一
Tues 星期二
Wed 星期三
Thur 星期四
Fri 星期五
Sat 星期六
Sun 星期日
EveryDay 每天
//示例数据
{
    "deviceSn": "*******",
    "channels": [
        {
            "recordType": "time",
            "channelId": 0,
            "streamId": 1,
            "recordAudio": false,
            "recordEncryt": false,
            "task": {
                "time": [
                    {
                        "week": "Mon",
                        "beginTime": "120000",
                        "endTime": "140000"
                    }
                ]
            }
        }
    ]
}

响应报文

名称 类型 是否必须 备注
code int 状态码
msg String 状态码解释信息
data Object 返回内容
//示例数据
{
    "code": 1000,
    "msg": "OK",
    "data": {}
}

错误码

状态码 状态描述
1000 成功
1001 参数错误
1002 请求异常
1006 AccessToken异常或过期
2008 设备不存在
5007 未开通全天云存储套餐

注意

  1. 对于传参【deviceSn】,有以下规则
    1. 具有 allcloud 设备能力的公有云设备序列号
  2. 对于传参【channels】列表中的参数,有以下规则
    1. 【task.time】参数,每天最多配置4个时间段
    2. 如果【recordType = "all"】,不管【task】有没有任务配置都按照【全天录像规则】下发录像计划
    3. 如果【recordType = "time"】,【task.time】列表必须配置时间段
    4. 该【channelId】已开启全天云存储套餐

results matching ""

    No results matching ""