视频 API 接口

更新时间：2019-03-22 12:40:49

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

API版本

2.0.0

配置录像计划

接口名：setUserRecordPlan
接口功能：以每个租户的项目为单位，创建或者修改录像计划。
接口路径：/vision/customer/record/plan/set

请求参数：

参数名 类型 是否必须 默认值 说明
name String 是 录像计划名称
allDay Int 是 是否全天 0为非全天 1为全天
timeSectionList JSON 是 非全天时时间信息

其中timeSection

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

返回参数：

参数名 类型 说明
planId String 录像计划ID

更新录像计划

接口名：updateUserRecordPlan
接口功能：以每个租户的项目为单位，修改录像计划。
接口路径：/vision/customer/record/plan/update

请求参数：

参数名 类型 是否必须 默认值 说明
planId String 是 录像计划
name String 否 录像计划名称
allDay Int 否 是否全天 0为非全天 1为全天
timeSectionList JSON 否 非全天时时间信息

其中timeSection

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

返回参数：
无

查询录像计划列表

接口名：queryUserRecordPlanList
接口功能：查询租户项目内的录像计划
接口路径：/vision/customer/record/plan/query

请求参数：

参数名 类型 是否必须 默认值 说明
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

获取录像计划详情

接口名：getRecordPlanByPlanId
接口功能：查询租户项目内的录像计划详情
接口路径：/vision/customer/record/plan/get

请求参数：

参数名 类型 是否必须 默认值 说明
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

删除录像计划

接口名：deleteUserRecordPlan
接口功能：删除租户内的对应录像计划
接口限制: 前提是删除所有计划内的关联设备
接口路径：/vision/customer/record/plan/delete

请求参数：

参数名 类型 是否必须 默认值 说明
planId String 是 录像计划ID

返回参数：
无

绑定录像计划到设备

接口名：bindRecordPlan
接口功能：设备与录像计划关联，绑定后设备按该计划执行录像
接口路径：/vision/customer/record/plan/bind

请求参数：

参数名 类型 是否必须 默认值 说明
planId String 是 录像计划ID
iotId String 是 设备ID
streamType Int 否 0 码流类型 主码流0，辅码流1

返回参数：
无

解绑设备的录像计划

接口名：unbindRecordPlan
接口功能：解除设备与录像计划关系，解除后设备停止录像
接口路径：/vision/customer/record/plan/unbind

请求参数：

参数名 类型 是否必须 默认值 说明
iotId String 是 设备ID
streamType Int 否 0 码流类型 主码流0，辅码流1

返回参数：
无

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

接口名：getRecordPlanByIotId
接口功能：根据IotId查询录像计划
接口路径：/vision/customer/record/plan/getbyiotid

请求参数：

参数名 类型 是否必须 默认值 说明
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

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

接口名：queryRecordPlanBindDeviceList
接口功能：查询绑定此录像计划的设备列表
接口路径：/vision/customer/record/plan/bind/device/query

请求参数：

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

返回参数：

参数名 类型 说明
total int 总数
currentCount int 当前页列数
deviceList JSON 设备列表

其中device:

参数名 类型 说明
iotId String 设备id
streamType int 流类型

配置事件联动录像计划

接口名：setEventRecordPlan
接口功能：以每个租户的项目为单位，创建或者修改事件录像计划。
接口路径：/vision/customer/eventrecord/plan/set

请求参数：

参数名 类型 是否必须 默认值 说明
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

更新事件联动录像计划

接口名：updateEventRecordPlan
接口功能：修改事件录像计划。
接口路径：/vision/customer/eventrecord/plan/update

请求参数：

参数名 类型 是否必须 默认值 说明
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

返回参数：
无

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

接口名：queryEventRecordPlanList
接口功能：查询租户项目内的事件联动录像计划的列表
接口路径：/vision/customer/eventrecord/plan/query

请求参数：

参数名 类型 是否必须 默认值 说明
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

删除事件联动录像计划

接口名：deleteEventRecordPlan
接口功能：删除租户内的对应的事件联动录像计划
接口限制: 前提是删除所有计划内的关联设备
接口路径：/vision/customer/eventrecord/plan/delete

请求参数：

参数名 类型 是否必须 默认值 说明
planId String 是 事件录像计划ID

返回参数：
无

获取事件联动计划详情

接口名：getEventRecordPlanByPlanId
接口功能：查询租户项目内的事件录像计划详情
接口路径：/vision/customer/eventrecord/plan/getbyid
请求参数：

参数名 类型 是否必须 默认值 说明
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

绑定事件联动计划到设备

接口名：bindEventRecordPlan
接口功能：将设备与事件录像计划关联
接口路径：/vision/customer/eventrecord/plan/device/bind

请求参数：

参数名 类型 是否必须 默认值 说明
planId String 是 事件录像计划ID
iotId String 是 设备ID
streamType Int 否 0 码流类型 主码流0，辅码流1

返回参数：
无

解绑设备的事件联动计划

接口名：unbindEventRecordPlan
接口功能：解绑设备的事件联动计划
接口路径：/vision/customer/eventrecord/plan/unbind

请求参数：

参数名 类型 是否必须 默认值 说明
iotId String 是 设备编号
streamType Int 否 0 码流类型 主码流0，辅码流1

返回参数：
无

根据设备ID查询事件录像计划

接口名：getEventRecordPlanByDevIotId
接口功能：根据IotId查询事件录像计划
接口路径：/vision/customer/eventrecord/plan/getbyiotid

请求参数：

参数名 类型 是否必须 默认值 说明
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

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

接口名：queryEventRecordPlanBindDeviceList
接口功能：查询计划关联设备信息
接口路径：/vision/customer/eventrecord/bind/device/query

请求参数：

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

返回参数：

参数名 类型 说明
total int 总数
currentCount int 当前页列数
deviceList JSON 设备列表

其中device

参数名 类型 说明
iotId String 设备id
streamType int 码流类型 0主码流 1辅码流

主动抓图

接口名： triggerPictureCapture
接口功能：触发视频设备抓取当前视频画面的图片，存储到云端
接口路径：/vision/customer/picture/trigger

请求参数：

参数名 类型 是否必须 默认值 说明
iotId String 是 设备ID

返回参数：

参数名 类型 说明
pictureId String 图片ID

查询录像列表

接口名：queryRecordList
接口功能：查询时间范围内设备录像存储的文件列表，支持分页查询
接口路径：/vision/customer/record/query

请求参数：

参数名 类型 是否必须 默认值 说明
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 生命周期 
[

]()

[

]()

[

]()

查询月录像

接口名：queryMonthRecord
接口功能：查询设备在某月的各天是否有存储录像
接口路径：/vision/customer/monthrecord/query

请求参数：

参数名 类型 是否必须 默认值 说明
iotId String 是 设备ID
month String 是 格式为yyyyMM,比如201806

返回参数：

参数名 类型 说明
recordFlags String 长度为当月天数，每位表示当天是否有录像

查询事件列表

接口名：queryEventList
接口功能：查询事件列表
接口路径：/vision/customer/event/query

请求参数：

参数名 类型 是否必须 默认值 说明
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获取文件播放地址

接口名：getVodByEventId
接口功能：获取设备事件存储的关联录像回放地址
接口路径：/vision/customer/vod/getbyeventid

请求参数：

参数名 类型 是否必须 默认值 说明
iotId String 是 设备ID
eventId String 是 事件ID

返回参数：

参数名 类型 是否必须 默认值 说明
vodList VodFile 是 播放列表

其中VodFile类型

参数名 类型 是否必须 默认值 说明
fileName String 是 文件名
vodUrl String 是 播放地址
beginTime String 是 开始时间
endTime String 是 结束时间

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

接口名：queryPictureListByIds
接口功能：获取设备事件存储的关联图片地址
接口路径：/vision/customer/picture/querybyids

请求参数：

参数名 类型 是否必须 默认值 说明
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

根据时间查询图片列表

接口名：queryPictureListByTime
接口功能：根据时间查询图片列表
接口路径：/vision/customer/picture/querybytime

请求参数：

参数名 类型 是否必须 默认值 说明
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

批量删除录像

接口名：batchDeleteRecord
接口功能：批量删除录像
接口路径：/vision/customer/record/batchdelete

请求参数：

参数名 类型 是否必须 默认值 说明
iotId String 是 设备ID
fileNameList List 是 录像文件名列表

返回参数：

参数名 类型 说明
deletedCount Int 删除成功个数

批量删除图片

接口名：batchDeletePicture
接口功能：批量删除图片
接口路径：/vision/customer/picture/batchdelete

请求参数：

参数名 类型 是否必须 默认值 说明
iotId String 是 设备ID
pictureIdList List 是 图片ID列表

返回参数：

参数名 类型 说明
deletedCount Int 删除成功个数

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

接口名：getPresentedCloudStorageDetail
接口功能：查询赠送的云存储套餐详情
接口路径：/vision/customer/cloudstorage/presented/get

请求参数：待添加

参数名 类型 是否必须 默认值 说明
iotId String 是 设备id

返回参数：

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

错误码：

领取赠送的云存储套餐

接口名：consumePresentedCloudStorage
接口功能：领取赠送的云存储套餐
接口路径：/vision/customer/cloudstorage/presented/consume

请求参数：待添加

参数名 类型 是否必须 默认值 说明
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 ""