Introduction
返回主页
文档说明
开始前必读
创建应用
对接模式
账户体系
资源下载
移动应用开发指南
应用开发
Android
OpenSDK组件
标准化Demo
iOS
OpenSDK组件
标准化Demo
桌面应用开发指南
应用开发
体验Demo
云直播开发指南
零门槛直播
自定义直播
新版轻应用开发指南
应用开发
轻应用组件
轻应用官方体验地址
轻应用开发指南
应用开发
轻应用组件
轻应用官方体验地址
消息推送开发指南
事件消息推送流程
事件消息类型定义
事件消息格式定义
HTTP接口
开发规范
Postman接口模拟调用
accessToken:获取管理员token
账户对接
子账户功能说明
createSubAccount:创建子账号
getOpenIdByAccount:根据子账号获取openid
deleteSubAccount:删除子账号
listSubAccount:获取子账号列表
subAccountToken:获取子账号Token
addPolicy:添加子账户权限
clearPolicy:清除子账号授权策略
queryDevicePermission:子账号设备维度权限
deleteDevicePermission:删除子账号设备权限
listSubAccountDevice:查询子账号有权限的设备列表
推送配置
setMessageCallback:设置报警回调地址
getMessageCallback:查看报警回调地址
设备托管
deviceListByAuthStatus:分页获取指定状态的授权设备列表
setDeviceAuthStatus:批量设置设备的授权状态
authorizedDeviceList:分页获取已授权的设备详情
授权消息推送
云存储服务
openCloudRecord:开通设备云存储
unBindDeviceCloud:解绑设备云存储
getDeviceCloud:获取当前设备的云存储服务信息
deviceCloudList:查询设备通道下所有云存储服务
setAllStorageStrategy:设置当前设备的云存储服务开关
setStorageStrategy:设置设备免费云存储服务开关
queryCloudRecordCallNum:查询云存储开通接口的剩余调用次数
unUsedCloudList:获取未启用的云存储服务列表
AI服务
createFaceRepository:人脸库创建
deleteFaceRepository:人脸库注销
faceDetect:人脸检测
addFaceRepositoryMember:人脸注册
deleteFaceRepositoryMember:人脸注销
faceSearch:人脸搜索
faceCompare:人脸比对
humanDetect:人形检测
humanDetail:人形识别
vehicleDetailDetect:车辆属性识别
vehicleTrafficDetect:车辆交通属性检测
设备管理
设备添加
bindDevice:绑定设备
unBindDevice:解绑设备
deviceAddingProcessGuideInfoGet:获取设备添加流程
deviceAddingProcessGuideInfoCheck:校验设备添加流程是否已更新
设备查询
deviceOnline:获取设备在线状态
unBindDeviceInfo:未绑定设备信息获取
checkDeviceBindOrNot:查询设备绑定情况
bindDeviceChannelInfo:单个设备通道的详细信息获取
deviceVersionList:获取设备版本和可升级信息
deviceOpenList:分页获取开放平台添加设备的通道基本信息
queryOpenDeviceChannelInfo:获取开放平台添加设备的通道基本信息
deviceOpenDetailList:批量获取设备的详细信息
deviceBaseList:分页获取乐橙app添加或分享的设备通道基本信息
queryBaseDeviceChannelInfo:获取乐橙app添加或分享设备的通道基本信息
deviceBaseDetailList:批量获取乐橙app添加或分享的设备详细信息
shareDeviceList:分页获取乐橙app分享给开发者设备列表
upgradeProcessDevice:获取设备升级状态和进度
listDeviceAbility:批量获取多个设备、通道以及配件的能力集
subAccountDeviceInfo:获取子账号下指定的授权设备详细信息
subAccountDeviceList:分页获取子账号下授权设备的详细信息
设备维护
modifyDeviceName:修改设备或通道名称
uploadDeviceCoverPicture:设置设备视频封面
refreshDeviceCover:设备/通道封面刷新
verifyPassword:验证设备密码
modifyPassword:修改设备密码
upgradeDevice:设备升级
设备配置
设备wifi配置
wifiAround:设备周边WIFI信息
controlDeviceWifi:控制设备连接热点
currentDeviceWifi:设备当前连接热点信息
设备动检配置
modifyDeviceAlarmStatus : 设置动检开关
deviceAlarmPlan:获取动检计划
modifyDeviceAlarmPlan:配置动检计划
setDeviceAlarmSensitivity:设置动检灵敏度
setDeviceAlarmRegion:设置动检区域
getDeviceAlarmParam:获取设备动检参数
设备存储配置
recoverSDCard:设备SD卡格式化
deviceStorage:获取设备存储介质容量信息
deviceSdcardStatus:获取设备SD卡状态
设备使能配置
setDeviceCameraStatus:设置设备使能开关
getDeviceCameraStatus:获取设备使能开关状态
设备收藏点配置
setCollection:新增收藏点
deleteCollection:删除收藏点
getCollection:获取收藏点信息
modifyCollection:修改收藏点名称
turnCollection:转动到收藏点
设备巡航配置
setCruiseConfig:设置定时巡航
getCruiseConfig:获取定时巡航设置
设备视频画面配置
setDeviceOsd:设置设备OSD配置
queryDeviceOsd:获取设备OSD配置
frameReverseStatus:获取设备翻转状态
modifyFrameReverseStatus:设置设备翻转状态
getZoomFocus:获取设备光学变焦倍数
setZoomFocus:设置设备光学变焦倍数
setNightVisionMode:设置设备夜视模式
getNightVisionMode:获取设备夜视模式配置
setFillLightSensitivity:设置设备补光灯灵敏度
getFillLightSensitivity:查询设备补光灯灵敏度
设备音量配置
setSoundVolumeSize:设置设备音量分贝
getSoundVolumeSize:获取设备音量分贝
设备录像配置
setLocalRecordPlanRules:设置设备本地录像计划
queryLocalRecordPlan:查询设备本地录像计划
setLocalRecordStream:设置设备本地录像视频流
queryLocalRecordStream:查询设备本地录像视频流
设备智能配置
setPreparation:预案设置
getPreparation:获取预案
setHeatMapEnable:设置热度分析通道级使能开关
getHeatMapEnable:获取热度分析通道级使能开关
getHeatMapData:热度图数据获取
设备操作
setDeviceSnap:设备抓图
setDeviceSnapEnhanced:设备抓图
controlMovePTZ:云台移动控制接口
controlLocationPTZ:云台定位接口
devicePTZInfo:获取设备云台控制接口
restartDevice:重启设备(只支持设备级重启)
calibrationDeviceTime:校准设备UTC时间
getDeviceTime:查询设备UTC时间
设备录像
本地录像
queryLocalRecordBitmap:按月查询本地录像掩码
queryLocalRecordNum:查询设备本地录像总数
queryLocalRecords:查询设备本地录像片段
云录像
queryCloudRecordBitmap:按月查询云录像掩码
queryCloudRecordByToken:根据cloudToken查询设备云录像片段信息
queryCloudRecordNum:查询设备云录像总数
queryCloudRecords:正序查询设备云录像片
getCloudRecords:倒序查询设备云录像片段
deleteCloudRecords:删除设备云录像片段
设备消息
deleteAlarmMessage:删除报警消息
getAlarmMessage:查询用户报警信息
getAlarmMessageById:根据id查询详细的报警消息
设备直播
bindDeviceLive:创建设备源直播地址
createDeviceRecordHls:创建设备hls录播地址
unbindLive:删除直播地址
liveList:获取直播列表
queryLiveStatus:获取直播状态
modifyLivePlanStatus:设置直播计划开关
modifyLivePlan:修改直播计划时间
batchModifyLivePlan:批量修改直播计划时间
getLiveStreamInfo:根据序列号获取直播地址和直播状态
createDeviceRtmpLive:创建rtmp协议直播地址
deleteDeviceRtmpLive:删除rtmp协议直播地址
queryDeviceRtmpLive:查询rtmp协议直播地址
createDeviceFlvLive:创建设备flv直播地址
deleteDeviceFlvLive:删除设备flv直播地址
queryDeviceFlvLive:查询设备通道flv直播地址
设备锁接入
getDevicePowerInfo:获取设备锁电量信息
openDoorRemote:远程开门
getDoorKeys:获取秘钥列表
getOpenDoorRecord:获取开门记录
generateSnapkey:生成门锁密码
deleteDoorKey:废弃密钥
getSnapkeyList:获取临时秘钥列表
wakeUpDevice:唤醒休眠的门锁设备
doorbellCallAnswer: 接听门口机/门铃呼叫
doorbellCallHangUp: 挂断门口机/门铃的呼叫
doorbellCallRefuse: 拒接门口机/门铃的呼叫
配件接入
addAPDevice:添加配件
deleteAPDevice:删除配件
getAddApInfo:获取配件详情
modifyAPDevice:修改配件名称
setApPlan:设置配件的布防计划
getApPlan:获取配件的布防计划
setApLinkage:设置配件联动的设备通道
getApLinkages:获取配件的联动列表
delApLinkages:删除配件联动的设备通道
getApAbleLinkages:获取配件可联动的设备列表
setApAlarmStatus:设置报警配件布防状态
getApAlarmStatus:获取报警配件布防状态
getApAlarmMessage:查询配件报警消息列表
getDeviceApLatestAlarmMessage:查询配件最近一条报警消息
deleteApAlarmMessage:删除指定消息id的配件报警信息
getApLinkageMessage:根据配件消息id查询联动设备的消息列表
getCloudRecordByApAlarmId:根据配件消息ID查询联动设备的云录像
getLocalRecordByApAlarmId:根据配件消息ID查询联动设备的本地录像
turnOffAlarm:消除配件报警
旧版本协议(后续不再维护)
controlPTZ:云台控制
deviceList:获取设备列表
bindDeviceInfo:单个设备信息获取
bindDeviceList:根据设备序列号获取多个设备信息
breathingLightStatus:获取呼吸灯状态
modifyBreathingLight:设置呼吸灯开关
setLocalRecordPlan:设置设备本地录像计划
参考文档
云存储套餐
设备能力开关
设备能力集
接口调用限制说明
全局返回码说明
云平台能力说明
SDK隐私协议
本书使用 GitBook 发布
云平台能力说明
云平台能力说明
可用性范围
可用性说明
业务可用性
基于公有云云原生架构部署,业务服务部署于多个机房,支持弹性扩容,业务可用性大于等于99.9%
业务数据可用性
分布式数据库,数据实时热备份、多副本存储以及本地备份的方式,保障业务数据高可靠性和可用性
视频数据可用性
云端存储使用分布式对象存储服务,跨区跨机房部署,保障数据可用性99.9%
results matching "
"
No results matching "
"