乐橙云开发文档
快速入门
  • 文档综述
  • 云直播开发指南
  • 轻应用开发指南
  • 移动应用开发指南
  • 桌面应用开发指南
  • 消息推送
  • 云转存
  • 国标GB28181设备接入
  • HTTP接口
  • 服务支持
前往官网
快速入门
  • 文档综述
  • 云直播开发指南
  • 轻应用开发指南
  • 移动应用开发指南
  • 桌面应用开发指南
  • 消息推送
  • 云转存
  • 国标GB28181设备接入
  • HTTP接口
  • 服务支持
前往官网
快速入门
  • 文档综述

  • 云直播开发指南

  • 轻应用开发指南

  • 小程序对接指南

  • 移动应用开发指南

  • 桌面应用开发指南

  • 消息推送

  • 云转存

  • 国标GB28181设备接入

  • IOT物模型

  • HTTP接口

    • API隐私协议
    • 开发规范
    • Postman按接口模拟调用教程
    • accessToken:获取管理员token
    • 设备

      • 设备直播

      • 设备管理

      • 设备配置

      • 设备操作

      • 设备录像

      • 设备消息

      • 设备托管

        • 设备托管说明
        • 分页获取指定状态的托管设备列表
        • 批量设置设备的托管状态
        • 分页获取已托管的设备详情
        • 授权消息推送
      • 设备锁接入

    • 账户对接

    • 推送配置

    • 云存储服务

    • AI服务

    • AI智见服务

    • 设备能力集
    • 设备能力开关
    • 接口调用限制说明
    • 全局返回码说明
    • 云平台能力说明
    • 旧版本协议(后续不再维护)

  • 服务支持

本页目录
功能说明
名词解释
基本流程
业务参数扩展
权限说明
各权限可操作的接口

设备托管说明

设备托管介绍

功能说明

演示图片

乐橙APP用户可以通过设备托管将设备的权限(视频预览,语音对讲、录像回放、设备管理)托管给乐橙开放平台的开发者用户,用于设备的二次开发。

有了设备托管功能,不仅可以让乐橙开放平台的开发者同时对多个终端账户设备集中管理,进行二次开发,而且不影响乐橙APP终端用户使用乐橙APP的全部体验;对于乐橙APP用户不但可以掌握设备所属权、拥有设备的全部使用权限,更可以自主控制托管权限信息,保障隐私安全。

举个例子,B端开发者希望通过乐橙云开放平台开发一个“店铺管理系统”,每个店铺的设备属于各个门店的乐橙APP账号,开发者需要通过二次开发集成视频相关功能进行管理者观看,各店铺将设备托管给开放平台开发者帐号,开发者方可进行二次开发。

名词解释

乐橙APP用户/终端用户:使用乐橙APP进行设备绑定的用户,可以将自己绑定的设备托管给乐橙开放平台开发者。

开放平台开发者:通过乐橙云开放平台二次开发的开发者客户,集成乐橙云提供的服务实现自己的应用或者系统。

基本流程

托管基本流程如下:

演示图片

业务参数扩展

如果开发者需要终端用户在托管设备时携带部分其他参数,并且在托管完成时平台将该参数回调给开发者,用以后续业务扩展,该功能可在托管授权链接中拼接参数实现。流程如下:

1、开发者在官网控制台开通托管服务后,获取到托管链接,示例https://open.imou.com/h5/company/abcde12345678910;

2、在托管链接中拼接state参数,参数值为开发者自定义的业务值(建议加密传输),示例https://open.imou.com/h5/company/abcde12345678910?state=weygfuygfbdfgfuysadknjhf12312312。然后将处理后的托管链接提供给指定终端用户;

3、终端用户访问处理后的托管链接,进行设备托管。完成后,平台会推送托管事件"msgType": "warrantInit"给到开发者,事件body体中会将state值原样返回(平台不会对值做处理)。托管事件请参考“授权消息推送”目录。

权限说明

设备托管按照设备维度进行权限分配,如果托管了指定设备指定权限,则开发者具有该设备下所有通道的指定权限,具体权限和解释如下:

托管页面中的权限大类权限描述
报警消息设备告警消息查询
设备操作设备配置权限,云台控制,设备抓图,设备升级,格式化SD卡
视频回放云录像回放,本地录像回放
视频预览实时预览,语音对讲

各权限可操作的接口

权限描述权限标识支持API(可直接通过左上方搜索)
设备告警消息查询AlarmdeleteAlarmMessage、getAlarmMessage、getAlarmMessageById
设备配置权限ConfigmodifyDeviceName、setDeviceCameraStatus、refreshDeviceCover、controlDeviceWifi、currentDeviceWifi、deleteCollection、deleteDoorKey、deviceAlarmPlan、frameReverseStatus、generateSnapkey、getCollection、getCruiseConfig、getDeviceAlarmParam、getDeviceCameraStatus、getDevicePowerInfo、getDoorKeys、getHeatMapData、getHeatMapEnable、getOpenDoorRecord、getPreparation、getSnapkeyList、getSoundVolumeSize、modifyCollection、modifyDeviceAlarmPlan、modifyDeviceAlarmStatus、modifyFrameReverseStatus、openDoorRemote、queryDeviceOsd、queryLocalRecordPlan、queryLocalRecordStream、setCollection、setCruiseConfig、setDeviceAlarmRegion、setDeviceAlarmSensitivity、setDeviceOsd、setHeatMapEnable、setLocalRecordPlan、setLocalRecordPlanRules、setLocalRecordStream、setPreparation、setSoundVolumeSize、turnCollection、wakeUpDevice、wifiAround
云台控制PtzcontrolLocationPTZ、controlMovePTZ、devicePTZInfo
设备抓图CapturesetDeviceSnap、setDeviceSnapEnhanced
设备升级UpgradedeviceVersionList、upgradeDevice、upgradeProcessDevice
格式化SD卡FormatdeviceSdcardStatus、deviceStorage、recoverSDCard
录像回放RecordReplayopenCloudRecord、queryCloudRecordBitmap、queryCloudRecordNum、queryCloudRecords、deleteCloudRecords、queryCloudRecordCallNum、unBindDeviceCloud、unUsedCloudList、getDeviceCloud、queryCloudRecordByToken、getCloudRecords、getRecordByLinkageId、deviceCloudList、queryLocalRecordBitmap、queryLocalRecordNum、queryLocalRecords
实时预览RealSDK 实时预览
语音对讲TalkSDK 语音对讲
反馈AI智慧消息准确性
分页获取指定状态的托管设备列表