提供关于LinkVisual视频服务的API接口。

配置录像计划

定义描述

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

请求参数

参数 类型 必填 默认值 描述
name String 录像计划名称
allDay int 是否全天
  • 0:为非全天
  • 1:为全天
timeSectionList List 入参allDay值为0(非全天)时的时段信息
timeZone int 8 UTC时区,取值区间-11~12
timeSection
参数 类型 必填 描述
dayOfWeek int 周日到周六,0代表周日,6代表周六
begin int 每天开始时间,单位秒,范围0-86399
end int 每天结束时间,单位秒,范围0-86399
timeSection

返回参数

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

更新录像计划

定义描述

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

请求参数

参数 类型 必填 默认值 描述
planId String 录像计划
name String 录像计划名称
allDay int 是否全天:0为非全天,1为全天
timeSectionList List 入参allDay值为0(非全天)时的时段信息
timeZone int 8 UTC时区,取值区间-11~12
timeSection
参数 类型 必填 描述
dayOfWeek int 周日到周六,0代表周日,6代表周六
begin int 每天开始时间,单位秒,范围0-86399
end int 每天结束时间,单位秒,范围0-86399
timeSection

返回参数

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

查询录像计划列表

定义描述

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

请求参数

参数 类型 必填 默认值 描述
pageStart int 0 起始页数,从0开始
pageSize int 20 每页个数,最大值是500
timeZone int 8 UTC时区,取值区间-11~12

返回参数

参数名 类型 必有 描述
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.1.0 获取录像计划详情 是,客户端SDK需启用身份的鉴权,进行身份认证

请求参数

参数 类型 必填 默认值 描述
planId String 录像计划ID
timeZone int 8 UTC时区,取值区间-11~12

返回参数

参数 类型 必有 描述
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.1.0 根据设备IotId查询绑定的录像计划 是,客户端SDK需启用身份的鉴权,进行身份认证

请求参数

参数 类型 必填 默认值 描述
iotId String 设备ID
streamType int 0 码流类型:0主码流,1辅码流
timeZone int 否8 8 UTC时区,取值区间-11~12

返回参数

参数 类型 必有 描述
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.1.0 配置事件联动录像计划,设备上报事件若落在计划范围内,则会通知设备推流并转存为云存录像,需要绑定到设备后才生效 是,客户端SDK需启用身份的鉴权,进行身份认证

请求参数

参数 类型 必填 默认值 描述
name String 计划名称
preRecordDuration int 0 预录时间,单位秒
recordDuration int 录像时间(总时间,包含预录部分), 单位秒
allDay int 是否全天:0非全天 ,1全天
eventTypeList List 事件类型列表,1移动侦测
timeSectionList List 入参allDay值为0(非全天)时的时段信息
timeZone int 8 UTC时区,取值区间-11~12
timeSection
参数 类型 必填 描述
dayOfWeek int 周日到周六,0代表周日,6代表周六
begin int 每天开始时间,单位秒,范围0-86399
end int 每天结束时间,单位秒,范围0-86399

返回参数

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

更新事件联动录像计划

定义描述

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

请求参数

参数 类型 必填 默认值 描述
planId String 事件录像计划ID
name String 事件录像计划名称
preRecordDuration int 0 预录时间, 单位秒
recordDuration int 录像时间(总时间,包含预录部分), 单位为秒
allDay int 是否全天:0非全天 ,1全天
eventTypeList List 事件类型列表,1移动侦测
timeSectionList List 入参allDay值为0(非全天)时的时段信息
timeZone int 8 UTC时区,取值区间-11~12
timeSection
参数 类型 必填 描述
dayOfWeek int 周日到周六,0代表周日,6代表周六
begin int 每天开始时间,单位秒,范围0-86399
end int 每天结束时间,单位秒,范围0-86399

返回参数

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

定义描述

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

请求参数

参数 类型 必填 默认值 描述
pageStart int 0 起始页数,从0开始
pageSize int 20 分页大小,最大值是500
timeZone int 8 UTC时区,取值区间-11~12

返回参数

参数 类型 必有 描述
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.1.0 获取事件联动录像计划详情 是,客户端SDK需启用身份的鉴权,进行身份认证

请求参数

参数 类型 必填 默认值 描述
planId String 事件联动录像计划ID
timeZone int 8 UTC时区,取值区间-11~12

返回参数

参数 类型 必有 描述
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.1.0 根据设备IotId查询事件联动录像计划 是,客户端SDK需启用身份的鉴权,进行身份认证

请求参数

参数 类型 必填 默认值 描述
iotId String 设备ID
streamType int 码流信息:0主码流 ,1辅码流
timeZone int 8 UTC时区,取值区间-11~12

返回参数

参数 类型 必有 描述
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.1.1 查询时间范围内的云端录像文件列表,支持分页查询,可通过查询出来的列表项中的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
needSnapshot boolean false 是否需要录像缩略图

返回参数

参数 类型 必有 描述
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 生命周期
snapshotUrl String 录像缩略图URL

获取云存录像点播地址

定义描述

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.1.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 事件附加信息
eventTimeUTC String 事件发生UTC时间,格式yyyy-MM-ssTHH:mm:ssZ

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

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/vod/getbyeventid 2.1.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
beginTimeUTC String 文件开始UTC时间,格式yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 文件结束UTC时间,格式yyyy-MM-ddTHH:mm:ssZ

批量删除录像

定义描述

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.2 查询赠送的云存储套餐详情 是,客户端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过期
startTimeUTC String 开始时间UTC,格式为yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 结束时间UTC,格式为yyyy-MM-ddTHH:mm:ssZ

领取赠送的云存储套餐

定义描述

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

请求参数

参数 类型 必填 默认值 描述
iotId String 设备id
enableDefaultPlan boolean false 是否设置7*24小时默认计划

返回参数

参数 类型 必有 描述
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 是否已过期
startTimeUTC String 开始时间UTC,格式为yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 结束时间UTC,格式为yyyy-MM-ddTHH:mm:ssZ

主动抓图

定义描述

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

请求参数

参数 类型 必填 描述
iotId String 设备ID

返回参数

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

根据时间查询图片列表

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/picture/querybytime 2.1.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
pictureTimeUTC String 图片创建时间UTC

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

定义描述

path 版本 描述 是否需要用户身份鉴权
/vision/customer/picture/querybyids 2.1.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
pictureTimeUTC String 图片创建时间UTC

批量删除图片

定义描述

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

请求参数

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

返回参数

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