LinkVisual视频服务

更新时间：2019-03-22 11:46:35

本节介绍客户端调用的LinkVisual视频服务API。通过API，可以在APP客户端完成摄像头的相关的功能设置与操作。例如：录像计划设置、事件联动录像规则、设备绑定关系等。

录像计划相关

配置录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/set 2.0.0 配置录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
name String 是 录像计划名称
allDay Int 是 是否全天 0为非全天 1为全天
timeSectionList JSON 是 非全天时时间信息
  • timeSection
参数 类型 必填 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六　
begin Int 是 每天开始时间，单位秒，范围0-86399　
end Int 是 每天结束时间，单位秒，范围0-86399　

返回参数

参数 类型 必有 描述
planId String 是 录像计划ID

错误码

请参考公共错误码

更新录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/update 2.0.0 更新录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 录像计划
name String 否 录像计划名称
allDay Int 否 是否全天 0为非全天 1为全天
timeSectionList JSON 否 非全天时时间信息
  • timeSection
参数 类型 必填 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六　
begin Int 是 每天开始时间，单位秒，范围0-86399　
end Int 是 每天结束时间，单位秒，范围0-86399　

返回参数

参数 类型 必有 描述
无

错误码

请参考公共错误码

查询录像计划列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/query 2.0.0 查询录像计划列表 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
pageStart int 否 0 起始页数，从0开始
pageSize int 否 20 分页大小，最大值是50

返回参数

参数名 类型 必有 描述
total int 是 总数
currentCount int 是 当前页返回记录数
recordPlanList JSON 是 录像计划列表
  • recordPlan
参数 类型 必有 描述
planId String 是 录像计划id
name String 是 录像计划名称
allDay Int 是 是否全天 0为非全天 1为全天
timeSectionList JSON 是 非全天时时间信息
  • timeSection
参数 类型 必有 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六
begin Int 是 每天开始时间，单位秒，范围0-86399
end Int 是 每天结束时间，单位秒，范围0-86399

错误码

请参考公共错误码

获取录像计划详情

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/get 2.0.0 获取录像计划详情 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 录像计划ID

返回参数

参数 类型 必有 描述
planId String 是 录像计划ID
name String　 是 录像计划名
allDay Integer 是 是否全天 0为非全天 1为全天
timeSectionList JSON 是 非全天时，配置的时间区间
  • timeSection
参数 类型 必有 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六　
begin Int 是 每天开始时间，单位秒，范围0-86399　
end Int 是 每天结束时间，单位秒，范围0-86399　

错误码

请参考公共错误码

删除录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/delete 2.0.0 删除录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 录像计划ID

返回参数

参数 类型 必有 说明
无

错误码

请参考公共错误码

绑定录像计划到设备

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/bind 2.0.0 设备与录像计划关联，绑定后设备按该计划执行录像 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 录像计划ID
iotId String 是 设备ID
streamType Int 否 0 码流类型。主码流0，辅码流1

返回参数

参数 类型 必有 描述
无

错误码

请参考公共错误码

解绑设备的录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/unbind 2.0.0 解除设备与录像计划关系，解除后设备停止录像 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
streamType Int 否 0 码流类型 主码流0，辅码流1

返回参数

参数 类型 必有 描述
无

错误码

请参考公共错误码

根据设备id查询绑定的录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/getbyiotid 2.0.0 根据设备IotId查询绑定的录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
streamType Int 否 0 码流类型 主码流0，辅码流1

返回参数

参数 类型 必有 描述
planId String 是 录像计划ID
name String　 是 录像计划名
allDay Integer 是 是否全天 0为非全天 1为全天
timeSectionList JSON 是 非全天时，配置的时间区间
  • timeSection
参数 类型 必有 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六　
begin Int 是 每天开始时间，单位秒，范围0-86399　
end Int 是 每天结束时间，单位秒，范围0-86399　

错误码

请参考公共错误码

查询绑定此录像计划的设备列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/bind/device/query 2.0.0 查询绑定此录像计划的设备列表 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 录像计划ID
pageStart int 否 0 起始页数，从0开始
pageSize int 否 20 分页大小，最大值是50

返回参数

参数 类型 必有 描述
total int 是 总数
currentCount int 是 当前页列数
deviceList JSON 是 设备列表
  • device:
参数 类型 必有 描述
iotId String 是 设备id
streamType int 是 流类型

错误码

请参考公共错误码

事件联动录像计划相关

配置事件联动录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/set 2.0.0 配置事件联动录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
name String 是 计划名称
preRecordDuration Int 否 0 预录时间
recordDuration Int 是 录像时间（总时间，包含预录部分）
allDay Int 是 是否全天 0为非全天 1为全天
eventTypeList JSON 是 事件类型列表，1移动侦测
timeSectionList JSON 是 非全天时，配置的时间区间
  • timeSection
参数 类型 必填 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六　
begin Int 是 每天开始时间，单位秒，范围0-86399　
end Int 是 每天结束时间，单位秒，范围0-86399　

返回参数

参数 类型 必有 描述
planId String 是 事件联动录像计划id

错误码

请参考公共错误码

更新事件联动录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/update 2.0.0 更新事件联动录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 事件录像计划ID
name String 否 事件录像计划名称
preRecordDuration Int 否 0 预录时间
recordDuration Int 否 录像时间（总时间，包含预录部分）
allDay Int 否 是否全天 0为非全天 1为全天
eventTypeList JSON 否 事件类型列表，1移动侦测
timeSectionList JSON 否 非全天时，配置的时间区间
  • timeSection
参数 类型 必填 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六　
begin Int 是 每天开始时间，单位秒，范围0-86399　
end Int 是 每天结束时间，单位秒，范围0-86399　

返回参数

参数 类型 必有 描述
无

错误码

请参考公共错误码

查询事件联动录像计划列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/query 2.0.0 查询事件联动录像计划列表 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
pageStart Int 否 0 起始页数，从0开始
pageSize Int 否 20 分页大小，最大值是50

返回参数

参数 类型 必有 描述
total Int 是 总数
currentCount Int 是 当前页列数
eventRecordPlanList JSON 是 事件录像计划列表
  • eventRecordPlanList：
参数 类型 必有 描述
planId String 是 事件录像计划ID
name String 是 事件录像计划名称
preRecordDuration Int 是 预录时间
recordDuration Int 是 录像时间（总时间，包含预录部分）
allDay Int 是 是否全天 0为非全天 1为全天
eventTypeList JSON 是 事件类型列表，1移动侦测
timeSectionList JSON 是 非全天时，配置的时间区间
  • timeSection
参数 类型 必有 描述

| dayOfWeek | Int | 是 | 周日到周六，0代表周日，6代表周六　 |
| begin | Int | 是 | 每天开始时间，单位秒，范围0-86399　 |
| end | Int | 是 | 每天结束时间，单位秒，范围0-86399　 |

错误码

请参考公共错误码

删除事件联动录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/delete 2.0.0 删除事件联动录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 事件录像计划ID

返回参数

参数 类型 必有 描述
无

错误码

请参考公共错误码

获取事件联动录像计划详情

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/getbyid 2.0.0 获取事件联动录像计划详情 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 事件联动录像计划id

返回参数

参数 类型 必有 描述
planId String 是 事件录像计划ID
name String　 是 事件录像计划名称
preRecordDuration Int 是 预录时间
recordDuration Int 是 录像时间（总时间，包含预录部分）
allDay Int 是 是否全天。0为非全天 1为全天
eventTypeList JSON 是 事件类型列表。1移动侦测
timeSectionList JSON 是 非全天时，配置的时间区间
  • timeSection
参数 类型 必有 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六　
begin Int 是 每天开始时间，单位秒，范围0-86399　
end Int 是 每天结束时间，单位秒，范围0-86399　

错误码

请参考公共错误码

绑定事件联动录像计划到设备

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/device/bind 2.0.0 绑定事件联动录像计划到设备 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 事件联动录像计划id
iotId String 是 设备ID
streamType Int 否 0 码流类型。主码流0，辅码流1

返回参数

参数 类型 必有 描述
无

错误码

请参考公共错误码

解绑设备的事件联动录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/unbind 2.0.0 解绑设备的事件联动录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备编号
streamType Int 否 　0 码流类型。主码流0，辅码流1

返回参数

参数 类型 必有 描述
无

错误码

请参考公共错误码

根据设备id查询事件联动录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/getbyiotid 2.0.0 根据设备IotId查询事件联动录像计划 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
streamType Int 否 码流信息。0主码流 1辅码流

返回参数

参数 类型 必有 描述
planId String 是 事件联动录像计划id
name String　 是 事件联动录像计划名称
preRecordDuration Int 是 预录时间，单位秒
recordDuration Int 是 录像时间（总时间，包含预录部分），单位秒
allDay Int 是 是否全天。0为非全天，1为全天
eventTypeList JSON 是 事件类型列表，1移动侦测
timeSectionList JSON 是 非全天时，配置的时间区间
  • timeSection
参数 类型 必有 描述
dayOfWeek Int 是 周日到周六，0代表周日，6代表周六　
begin Int 是 每天开始时间，单位秒，范围0-86399　
end Int 是 每天结束时间，单位秒，范围0-86399　

错误码

请参考公共错误码

查询事件联动录像计划所关联的设备列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/bind/device/query 2.0.0 查询事件联动录像计划所关联的设备列表 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
planId String 是 事件录像计划id
pageStart int 否 0 起始页数，从0开始
pageSize int 否 20 分页大小

返回参数

参数 类型 必有 描述
total int 是 总数
currentCount int 是 当前页列数
deviceList JSON 是 设备列表
  • device
参数 类型 必有 说明
iotId String 是 设备id
streamType int 是 码流类型。0主码流，1辅码流

错误码

请参考公共错误码

主动抓图

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/picture/trigger 2.0.0 触发设备抓图上传到云端 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备id

返回参数

参数 类型 必有 描述
pictureId String 是 图片ID

错误码

请参考公共错误码

查询云端的录像列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/query 2.0.0 查询时间范围内的云端录像文件列表，支持分页查询 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
streamType Int 否 0 码流类型
beginTime Int 是 查询开始时间，1970年1月1日开始的秒数
endTime Int 是 查询结束时间，1970年1月1日开始的秒数
recordType Int 否 99（全部） 录像类型
pageStart int 否 0 起始页数，从0开始
pageSize int 否 20 分页大小

返回参数

参数 类型 必有 描述

| recordFileList | JSON | 是 | 云端录像文件列表 |
| record | JSON | 是 | 录像文件信息 |
| beginTime | String | 是 | 文件开始时间，格式yyyy-MM-dd HH:mm:ss |
| endTime | String | 是 | 文件结束时间，格式yyyy-MM-dd HH:mm:ss |
| recordType | Int | 是 | 录像类型 |
| streamType | Int | 是 | 码流类型 |
| fileName | String | 是 | 文件名 |
| fileSize | Int | 是 | 生命周期 |

错误码

请参考公共错误码

查询月录像

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/monthrecord/query 2.0.0 查询设备在某月的各天是否有云存储录像 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备id
month String 是 格式为yyyyMM,比如201806

返回参数

参数 类型 必有 描述
recordFlags String 是 长度为当月天数，每位表示当天是否有录像

错误码

请参考公共错误码

查询事件列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/event/query 2.0.0 查询事件列表 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
beginTime Iong 是 查询开始时间，1970年1月1日开始的毫秒数
endTime Iong 是 查询结束时间，1970年1月1日开始的毫秒数
eventType Int 否 0 全部，1移动侦测 事件类型
pageStart int 否 0 起始页数，从0开始
pageSize int 否 20 分页大小

返回参数

参数 类型 必有 描述
eventList JSON 是 事件列表
event Object 是 事件信息
eventId String 是 事件id
eventTime String 是 事件发生时间，格式yyyy-MM-ss HH:mm:ss
eventType Int 是 事件类型
eventDesc String 是 事件描述
eventPictureId String 是 事件关联图片
eventFileName String 是 事件关联录像
eventData String 是 事件附加信息

错误码

请参考公共错误码

根据事件id获取文件播放地址

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/vod/getbyeventid 2.0.0 根据事件ID获取文件播放地址 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
eventId String 是 事件ID

返回参数

参数 类型 必有 描述
vodList VodFile 是 播放列表
  • VodFile
参数 类型 必有 描述
fileName String 是 文件名
vodUrl String 是 播放地址
beginTime String 是 开始时间
endTime String 是 结束时间

错误码

请参考公共错误码

根据图片id列表获取图片地址

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/picture/querybyids 2.0.0 根据图片id列表获取图片地址 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
pictureIdList List 是 图片ID列表
type Int 否 0 图片类型 0全部 1原图 2缩率图

返回参数

参数 类型 必有 描述
pictureList JSON 是 图片列表
  • picture
参数 类型 必有 描述
iotId String 是 设备ID
pictureId String 是 图片ID
pictureTime String 是 图片创建时间
pictureUrl String 是 图片URL
thumbUrl String 是 图片缩略图URL

错误码

请参考公共错误码

根据时间查询图片列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/picture/querybytime 2.0.0 根据时间查询图片列表 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
startTime Long 是 开始时间，1970年1月1日开始的毫秒数
endTime Long 是 结束时间，1970年1月1日开始的毫秒数
pageStart Int 否 0 起始页，从0开始
pageSize Int 否 20 每页个数
type Int 否 0 图片类型。0全部，1原图，2缩略图
source Int 否 0 图片来源。0全部，1报警抓图，2主动抓图，3其他

返回参数

参数 类型 必有 描述
pictureList JSON 是 图片列表
  • picture
参数 类型 必有 说明
iotId String 是 设备ID
pictureId String 是 图片ID
pictureTime String 是 图片创建时间
pictureUrl String 是 图片URL
thumbUrl String 是 图片缩略图URL

错误码

请参考公共错误码

批量删除录像

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/batchdelete 2.0.0 批量删除录像 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备id
fileNameList List 是 录像文件名列表

返回参数

参数 类型 必有 描述

| deletedCount | Int | 是 | 删除成功个数 |

错误码

请参考公共错误码

批量删除图片

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/picture/batchdelete 2.0.0 批量删除图片 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必有 默认值 描述
iotId String 是 设备ID
pictureIdList List 是 图片ID列表

返回参数

参数 类型 必有 描述
deletedCount Int 是 删除成功个数

错误码

请参考公共错误码

查询赠送的云存储套餐详情

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/cloudstorage/presented/get 2.0.0 查询赠送的云存储套餐详情 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备id

返回参数

参数 类型 必有 描述
type int 是 云存储套餐类型：连续型为1，事件型2
lifecycle int 是 存储周期
months int 是 服务周期
consumed int 是 是否已领取，0未领取，1已领取
startTime String 否 开始时间
endTime String 否 结束时间
expired int 是 是否已过期，0未过期，1过期

错误码

请参考公共错误码

领取赠送的云存储套餐

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/cloudstorage/presented/consume 2.0.0 领取赠送的云存储套餐 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备id

返回参数

参数 类型 必有 描述
type int 是 云存储套餐类型：事件型0，连续型1
lifecycle int 是 存储周期
months int 是 服务周期
consumed int 是 是否已领取，0为领取，1已领取
startTime String 否 开始时间
endTime String 否 结束时间
expired int 是 是否已过期

错误码

请参考公共错误码

results matching ""

    No results matching ""