LinkVisual 客户端调用API接口文档

更新时间：2020-03-13 10:13:57

使用LinkVisual视频服务需要参照自有品牌APP开发指南集成SDK基础包。

录像计划相关

配置录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/plan/set 2.0.0 配置录像计划，在计划时间范围内则通知设备推流，云存录像单个文件长度不超过30分钟，需要与设备绑定后才计划才会生效 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
name String 是 录像计划名称
allDay int 是 是否全天:0为非全天,1为全天
timeSectionList List 是 入参allDay值为0（非全天）时的时段信息
  • 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 List 否 入参allDay值为0（非全天）时的时段信息
  • 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 每页个数，最大值是500

返回参数

参数名 类型 必有 描述
total int 是 总数
currentCount int 是 当前页返回记录数
recordPlanList List 是 录像计划列表
  • recordPlan
参数 类型 必有 描述
planId String 是 录像计划ID
name String 是 录像计划名称
allDay int 是 是否全天:0为非全天,1为全天
timeSectionList List 是 入参allDay值为0（非全天）时的时段信息
  • 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 int 是 是否全天:0为非全天,1为全天
timeSectionList List 是 入参allDay值为0（非全天）时的时段信息
  • 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 int 是 是否全天:0非全天,1全天
timeSectionList List 是 入参allDay值为0（非全天）时的时段信息
  • 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 分页大小，最大值是500

返回参数

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

错误码
请参考公共错误码

事件联动录像计划相关

配置事件联动录像计划

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/eventrecord/plan/set 2.0.0 配置事件联动录像计划，设备上报事件若落在计划范围内，则会通知设备推流并转存为云存录像，需要绑定到设备后才生效 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
name String 是 计划名称
preRecordDuration int 否 0 预录时间，单位秒
recordDuration int 是 录像时间（总时间，包含预录部分）, 单位秒
allDay int 是 是否全天:0非全天 ,1全天
eventTypeList List 是 事件类型列表，1移动侦测
timeSectionList List 是 入参allDay值为0（非全天）时的时段信息
  • 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 List 否 事件类型列表，1移动侦测
timeSectionList List 否 入参allDay值为0（非全天）时的时段信息
  • 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 分页大小，最大值是500

返回参数

参数 类型 必有 描述
total int 是 总数
currentCount int 是 当前页列数
eventRecordPlanList List 是 事件录像计划列表
  • eventRecordPlan
参数 类型 必有 描述
planId String 是 事件录像计划ID
name String 是 事件录像计划名称
preRecordDuration Int 是 预录时间，单位秒
recordDuration Int 是 录像时间（总时间，包含预录部分)，单位秒
allDay Int 是 是否全天:0非全天,1全天
eventTypeList List 是 事件类型列表，1移动侦测
timeSectionList List 是 入参allDay值为0（非全天）时的时段信息
  • 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 List 是 事件类型列表。1移动侦测
timeSectionList List 是 入参allDay值为0（非全天）时的时段信息
  • 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 是 设备ID
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 List 是 事件类型列表，1移动侦测
timeSectionList List 是 入参allDay值为0（非全天）时的时段信息
  • 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 每页个数，最大值500

返回参数

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

错误码
请参考公共错误码

云存录像相关

根据时间范围查询云存的录像列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/query 2.0.0 查询时间范围内的云端录像文件列表，支持分页查询，可通过查询出来的列表项中的filename来获取播放地址 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
streamType Int 否 0 码流类型:0主码流，1辅码流
beginTime Int 是 查询开始时间，1970年1月1日开始的秒数
endTime Int 是 查询结束时间，1970年1月1日开始的秒数
recordType Int 否 99（全部） 录像类型:0 计划录像，1 报警录像，2 主动录像，3 边看边录
pageStart int 否 0 起始页数，从0开始
pageSize int 否 20 每页个数，最大值500

返回参数

参数 类型 必有 描述
recordFileList JSON 是 云端录像文件列表
record JSON 是 录像文件信息
beginTime String 是 文件开始时间，格式yyyy-MM-dd HH:mm:ss
endTime String 是 文件结束时间，格式yyyy-MM-dd HH:mm:ss
recordType Int 是 录像类型：0 计划录像，1 报警录像，2 主动录像，3 边看边录
streamType Int 是 码流类型:0主码流，1辅码流
fileName String 是 文件名
fileSize Int 是 生命周期

错误码
请参考公共错误码

获取云存录像点播地址

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/vod/getbyfilename 2.0.0 按文件名获取设备云存录像播放地址 是，客户端SDK需启用身份的鉴权

请求参数

参数名 类型 是否必须 默认值 说明
iotId String 是 设备ID
fileName String 是 文件名，录像查询返回

返回参数

参数名 类型 说明
vodUrl String 点播地址，带鉴权信息，无法重复使用

错误码
请参考公共错误码

查询月录像

定义描述

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 List 是 事件列表
  • event
参数 类型 必有 描述
eventId String 是 事件ID，若有生效的事件联动录像计划，则可根据事件ID来获取云存计划录像播放地址
eventTime String 是 事件发生时间，格式yyyy-MM-ss HH:mm:ss
eventType int 是 事件类型， 1移动侦测
eventDesc String 是 事件描述
eventPictureId String 是 事件关联图片ID
eventData String 是 事件附加信息

错误码
请参考公共错误码

根据事件id获取云存录像文件播放地址

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/vod/getbyeventid 2.0.0 根据事件ID获取云存录像文件播放地址，需要设备提前配置了生效的事件联动录像计划 是，客户端SDK需启用身份的鉴权

请求参数

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

返回参数

参数 类型 必有 描述
vodList List 是 播放列表
  • vodFile
参数 类型 必有 描述
fileName String 是 文件名
vodUrl String 是 播放地址
beginTime String 是 文件开始时间，格式yyyy-MM-dd HH:mm:ss
endTime String 是 文件结束时间，格式yyyy-MM-dd HH:mm:ss

错误码
请参考公共错误码

批量删除录像

定义描述

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

请求参数

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

返回参数

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

错误码
请参考公共错误码

云端录像下载

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/vod/cloudfile/get 2.1.0 请求云端录像下载地址。云端录像需要进行MP4转码，这一过程会比较耗时，APP需要轮询该接口获取进度。 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
fileName String 是 录像文件名

返回参数

参数 类型 必有 描述
url String 是 云端录像下载url。转码中url为空，转码成功后返回生成url。
status int 是 录像转码状态，0成功，1转码中，-1转码异常
progress int 是 录像转码进度，百分比0-100

错误码
请参考公共错误码

主动触发设备进行短录像任务

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/record/trigger 2.1.0 触发设备主动推流，作为事件联动录像上传并存储在云端，需要事先为设备配置事件联动录像计划并为开通云存储 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 默认值 描述
iotId String 是 设备ID
recordDuration int 是 录制时长，单位秒，最大值1800
streamType int 否 0 码流类型，0表示主码流，1表示辅码流
preRecordDuration int 否 0 预录时长，单位秒

返回参数

参数 类型 必有 描述
recordId String 是 云存录像id

错误码
请参考公共错误码

云存套餐相关

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

定义描述

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

请求参数

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

返回参数

参数 类型 必有 描述
type int 是 云存储套餐类型：连续型为1，事件型2
lifecycle int 是 数据在云端的存储周期, 只有1/3/7/30天
months int 是 云存储服务有效期, 从1开始, 单位月
consumed int 是 是否已领取，0未领取，1已领取
startTime String 否 开始时间，格式为yyyy-MM-dd HH:mm:ss
endTime String 否 结束时间，格式为yyyy-MM-dd HH:mm:ss
expired int 是 是否已过期，0未过期，1过期

错误码
请参考公共错误码

领取赠送的云存储套餐

定义描述

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

请求参数

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

返回参数

参数 类型 必有 描述
type int 是 云存储套餐类型：事件型0，连续型1
lifecycle int 是 数据在云端的存储周期, 只有1/3/7/30天
months int 是 云存储服务有效期, 从1开始, 单位月
consumed int 是 是否已领取，0为领取，1已领取
startTime String 否 开始时间，格式为yyyy-MM-dd HH:mm:ss
endTime String 否 结束时间，格式为yyyy-MM-dd HH:mm:ss
expired int 是 是否已过期

错误码
请参考公共错误码

图片相关

主动抓图

定义描述

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

请求参数

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

返回参数

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

错误码
请参考公共错误码

根据时间查询图片列表

定义描述

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 每页个数,最大值100
type int 否 0 图片类型:0全部，1原图，2缩略图
source int 否 0 图片来源:0全部，1报警抓图，2主动抓图，3其他

返回参数

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

错误码
请参考公共错误码

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

定义描述

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

请求参数

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

返回参数

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

错误码
请参考公共错误码

批量删除图片

定义描述

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

请求参数

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

返回参数

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

错误码
请参考公共错误码

results matching ""

    No results matching ""