开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
      • 通用方法
        • 能力使用
        • device.capability.list(查询可用能力)
        • device.property.get(批量读配置)
        • device.property.set(批量写配置)
        • device.service.invoke(调用一次动作)
      • 侦测与告警
      • 图像
      • 云台
      • 灯光
      • 录像
      • 音频
      • 媒体
      • 网络
      • 电源
      • 隐私
      • 呼叫
      • 存储
      • 系统
      • 算法
      • 设备维护
      • 控制
    • 事件总览
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持

能力使用

能力使用

改开关、转云台走下面四条。某一项的取值在对应的获取 / 设置页。

功能方法名说明
查询可用能力device.capability.list这台设备或这个型号支持哪些项
批量读配置device.property.get一次读多项配置
批量写配置device.property.set一次写多项配置;越界拒绝、不截断
调用一次动作device.service.invoke转云台、抓图等,不幂等

按下表检索。通道级要带 channelId(IPC 常见 "0"),漏了返回 DV2007。设备和通道写在同一次请求里返回 DV2008。

重启、校时、WiFi、升级、改名见 其他能力接口。详情、在离线、绑定见 设备管理。事件也可按 事件总表 查。

跳到:侦测 · 图像 · 云台 · 灯光 · 录像 · 音频 · 媒体 · 网络 · 电源 · 隐私 · 呼叫 · 存储 · 系统 · 算法 · 控制

名称ID操作
布撤防detection.arming.enabled获取 / 设置
报警去抖时长detection.arming.debounceDuration获取 / 设置
事件触发间隔detection.arming.triggerInterval获取 / 设置
报警间隔detection.arming.interval获取 / 设置
本机联动能力detection.arming.roles获取
关联设备报警detection.arming.linkedDevice获取 / 设置
布撤防模式变化detection.arming.changed上报
布撤防模式detection.arming.mode获取 / 设置
离家延时detection.arming.leaveDelay获取 / 设置
模式设置detection.arming.applyMode调用
模式查询detection.arming.queryMode调用
门磁状态detection.door.contactState获取
开门告警detection.door.opened上报
关门告警detection.door.closed上报
门控-告警时长detection.gate.alarmDuration获取 / 设置
门控-告警类型detection.gate.alarmType获取 / 设置
门磁检测开关detection.gate.contactCheck获取 / 设置
门控报警设置detection.gate.alarmSetting获取 / 设置
门控-门开detection.gate.opened上报
门控-门关detection.gate.closed上报
长时间未关门detection.gate.leftOpen上报
当前温度detection.environment.temperature获取 / 设置
当前湿度detection.environment.humidity获取 / 设置
环境高温报警detection.environment.temperatureHigh上报
环境低温报警detection.environment.temperatureLow上报
高湿度报警detection.environment.humidityHigh上报
低湿度报警detection.environment.humidityLow上报
防拆报警detection.tamper.detected上报
关注区域检出detection.attention.detected上报
客流统计detection.counting.enabled获取 / 设置
客流增量detection.counting.increment获取
客流区域detection.counting.region获取 / 设置
客流灵敏度detection.counting.sensitivity获取 / 设置
清除客流数据detection.counting.clear调用
删除特征图detection.counting.deletePic调用
下发特征图detection.counting.distributePic调用
特征图分页查询detection.counting.picPage调用
特征图状态detection.counting.picState调用
特征图识别结果detection.counting.picRecognized上报
哭声检测detection.cry.enabled获取 / 设置
哭声敏感度detection.cry.sensitivity获取 / 设置
啼哭声报警事件detection.cry.detected上报
离岗检测detection.duty.enabled获取 / 设置
离岗时长detection.duty.duration获取 / 设置
在岗人数detection.duty.count获取 / 设置
离岗布防detection.duty.plan获取 / 设置
离岗检出detection.duty.detected上报
人脸检测detection.face.enabled获取 / 设置
人脸库配置detection.face.config获取 / 设置
查询人脸库detection.face.list调用
人脸库导入进度detection.face.importProgress调用
通知人脸库更新detection.face.notifyUpdate调用
人脸比对detection.face.detected上报
跌倒检测detection.fall.enabled获取 / 设置
跌倒检出detection.fall.detected上报
目标检测框detection.frame.enabled获取 / 设置
手势呼叫detection.gesture.enabled获取 / 设置
区域入侵移动检测detection.intrusion.enabled获取 / 设置
人形过滤detection.intrusion.personFilter获取 / 设置
车辆过滤detection.intrusion.vehicleFilter获取 / 设置
动物过滤detection.intrusion.petFilter获取 / 设置
画面变化入侵区域detection.intrusion.region获取 / 设置
区域入侵区域最大范围detection.intrusion.maxRange获取
区域入侵灵敏度detection.intrusion.sensitivity获取 / 设置
入侵布防detection.intrusion.plan获取 / 设置
删除区域入侵区域detection.intrusion.delete调用
重命名区域入侵区域detection.intrusion.rename调用
区域入侵检测报警detection.intrusion.detected上报
徘徊检测detection.loitering.enabled获取 / 设置
徘徊停留时长detection.loitering.duration获取 / 设置
徘徊布防detection.loitering.plan获取 / 设置
徘徊检出detection.loitering.detected上报
未成年检测detection.minor.enabled获取 / 设置
未成年检出detection.minor.detected上报
AI提醒-混合出现detection.mix.detected上报
移动检测开关detection.motion.enabled获取 / 设置
动检灵敏度detection.motion.sensitivity获取 / 设置
侦测范围detection.motion.range获取 / 设置
检测距离detection.motion.distance获取 / 设置
检测区域detection.motion.region获取 / 设置
检测区域最大范围detection.motion.maxRange获取
检测时间段detection.motion.plan获取 / 设置
动检跟踪detection.motion.tracking获取 / 设置
动检报警原数据detection.motion.metadata调用
移动检测报警detection.motion.detected上报
视频遮挡开关detection.occlusion.enabled获取 / 设置
视频遮挡灵敏度detection.occlusion.sensitivity获取 / 设置
视频遮挡检出detection.occlusion.detected上报
车辆违停detection.parking.enabled获取 / 设置
违停时长detection.parking.duration获取 / 设置
违停布防detection.parking.plan获取 / 设置
违停检出detection.parking.detected上报
人形检测detection.person.enabled获取 / 设置
人形灵敏度detection.person.sensitivity获取 / 设置
人形布防detection.person.plan获取 / 设置
人形检测框detection.person.frame获取 / 设置
智能跟踪detection.person.tracking获取 / 设置
特写跟踪区域detection.person.trackRegion获取 / 设置
智能检测到人形detection.person.detected上报
宠物检测detection.pet.enabled获取 / 设置
宠物灵敏度detection.pet.sensitivity获取 / 设置
宠物布防detection.pet.plan获取 / 设置
宠物检测框detection.pet.frame获取 / 设置
宠物跟踪detection.pet.tracking获取 / 设置
宠物检出detection.pet.detected上报
开始PIR测距detection.pir.start调用
结束PIR测距detection.pir.stop调用
PIR 检出detection.pir.detected上报
PIR 消警detection.pir.cleared上报
车牌识别detection.plate.enabled获取 / 设置
免检车牌detection.plate.ignore获取 / 设置
车牌识别detection.plate.detected上报
车辆守卫detection.sentry.enabled获取 / 设置
车辆守卫布防detection.sentry.plan获取 / 设置
车辆守卫检出detection.sentry.detected上报
警笛detection.siren.enabled获取
报警联动警笛detection.siren.linkage获取 / 设置
警笛联动事件detection.siren.linkageEvents获取 / 设置
警笛布防检测时间段detection.siren.plan获取 / 设置
警笛状态detection.siren.state获取
开启警笛detection.siren.start调用
关闭警笛detection.siren.stop调用
获取警笛状态倒计时detection.siren.countdown调用
设置警笛时长detection.siren.duration调用
警笛瞬时告警detection.siren.activated上报
警笛保持时长detection.siren.holdDuration获取 / 设置
语音呼救detection.sos.enabled获取 / 设置
语音呼救灵敏度detection.sos.sensitivity获取 / 设置
方言呼救检测detection.sos.dialect获取 / 设置
语音呼救(通用)detection.sos.detected上报
异常音detection.sound.enabled获取 / 设置
异常音阈值detection.sound.threshold获取 / 设置
异常音报警事件detection.sound.detected上报
越线检测detection.trip.enabled获取 / 设置
越线检测区域detection.trip.region获取 / 设置
越线布防detection.trip.plan获取 / 设置
越线检出detection.trip.detected上报
无人出现detection.unmanned.enabled获取 / 设置
无人持续时长detection.unmanned.duration获取 / 设置
检测区域数量detection.unmanned.regionCount获取
无人出现布防detection.unmanned.plan获取 / 设置
无人出现检出detection.unmanned.detected上报
车辆检测detection.vehicle.enabled获取 / 设置
车辆灵敏度detection.vehicle.sensitivity获取 / 设置
车辆布防detection.vehicle.plan获取 / 设置
车辆检测框detection.vehicle.frame获取 / 设置
车辆跟踪detection.vehicle.tracking获取 / 设置
车辆检出detection.vehicle.detected上报
防闪烁开关image.flicker.enabled获取 / 设置
相机防闪烁配置image.flicker.config获取 / 设置
夜视开关image.night.enabled获取 / 设置
夜视模式image.night.mode获取 / 设置
夜视切换方式image.night.switchMode获取 / 设置
定时夜视计划image.night.plan获取 / 设置
摄像机画面翻转image.orient.enabled获取 / 设置
校准状态image.orient.calibStatus获取
画面校准image.orient.calibrate调用
PN制image.standard.type获取
PN制式切换image.standard.switch调用
宽动态模式image.wdr.mode获取 / 设置
宽动态模式image.wdr.mode获取 / 设置
云台转速ptz.aim.speed获取 / 设置
广角扫描距离ptz.aim.scanDistance获取
按速度转动ptz.aim.relative调用
按步转动ptz.aim.step调用
复位ptz.aim.reset调用
巡航模式ptz.cruise.mode获取 / 设置
智能巡航ptz.cruise.smart获取 / 设置
巡航间隔ptz.cruise.interval获取 / 设置
巡航最少预置点数ptz.cruise.minPresets获取
巡航时间段ptz.cruise.plan获取 / 设置
获取巡航信息ptz.cruise.get调用
设置巡航信息ptz.cruise.set调用
枪球联动开关ptz.linkage.enabled获取 / 设置
手动枪球联动ptz.linkage.invoke调用
收藏点停留时间ptz.preset.stayTime获取 / 设置
守望ptz.preset.idle获取 / 设置
收藏点空闲动作检测延时时间ptz.preset.idleDelay获取 / 设置
回归收藏点信息ptz.preset.return获取 / 设置
添加收藏点ptz.preset.add调用
删除收藏点ptz.preset.delete调用
转到收藏点ptz.preset.goto调用
获取收藏点ptz.preset.list调用
重命名收藏点ptz.preset.rename调用
设置收藏点ptz.preset.set调用
变焦倍数ptz.zoom.value获取 / 设置
自动变倍聚焦ptz.zoom.auto获取 / 设置
变焦精度ptz.zoom.accuracy获取
设置变倍聚焦倍数ptz.zoom.set调用
红蓝灯light.alert.enabled获取 / 设置
报警联动红蓝灯light.alert.linkage获取 / 设置
红蓝灯联动事件light.alert.linkageEvents获取 / 设置
红蓝灯布防检测时间段light.alert.plan获取 / 设置
开启红蓝灯light.alert.start调用
关闭红蓝灯light.alert.stop调用
红蓝灯倒计时light.alert.countdown调用
补光灯灵敏度light.fill.sensitivity获取 / 设置
夜间补光距离light.fill.distance获取 / 设置
设备指示灯light.indicator.enabled获取 / 设置
红外灯设置light.ir.mode获取 / 设置
探照灯light.searchlight.enabled获取 / 设置
白光light.white.enabled获取 / 设置
白光灯模式light.white.mode获取 / 设置
白光亮度light.white.level获取 / 设置
报警联动白光灯light.white.linkage获取 / 设置
白光联动事件light.white.linkageEvents获取 / 设置
白光灯布防检测时间段light.white.plan获取 / 设置
白光定时light.white.timer获取 / 设置
白光灯默认倒计时长light.white.countdown获取
获取白光灯运行状态(含剩余倒计时)light.white.state获取
开启倒计时白光灯light.white.start调用
关闭倒计时白光灯light.white.stop调用
普通事件投递record.event.detected上报
SD卡录像封面图record.file.cover获取
本地录像每页文件数record.file.pageSize获取
局域网下载record.file.download获取
获取本地录像record.file.list调用
获取本地录像(根据消息时间)record.file.alarmList调用
获取本地录像总数record.file.count调用
获取本地录像掩码record.file.bitmap调用
录像存储record.plan.enabled获取 / 设置
普通录像存储record.plan.normal获取 / 设置
存储计划record.plan.plan获取 / 设置
本地录像存储模式record.plan.storageMode获取 / 设置
本地录像参数record.plan.config获取 / 设置
最大录像时长record.plan.maxDuration获取 / 设置
本地录像快进record.playback.forward获取
延时摄影状态record.timelapse.state获取
创建延时摄影任务record.timelapse.create调用
删除延时摄影任务record.timelapse.delete调用
结束延时摄影任务record.timelapse.end调用
获取正在执行的延时摄影任务record.timelapse.executing调用
获取设备延时摄影相册任务日历record.timelapse.calendar调用
获取延时摄影任务下载文件列表record.timelapse.files调用
延时摄影完成事件record.timelapse.completed上报
免打扰时间计划audio.dnd.plan获取 / 设置
铃声免打扰audio.dnd.ringer获取 / 设置
麦克风采集audio.mic.enabled获取 / 设置
设备提示音audio.prompt.enabled获取 / 设置
提示音档位audio.prompt.level获取 / 设置
铃声配置audio.ring.config获取 / 设置
铃声配置(设备报警)audio.ring.alarmConfig获取 / 设置
设备报警铃声audio.ring.alarmBell获取 / 设置
铃声数量audio.ring.maxCount获取
新增铃声audio.ring.add调用
删除铃声audio.ring.delete调用
全量更新自定义铃声列表audio.ring.updateList调用
报警语音audio.speech.enabled获取 / 设置
声音分贝设置audio.speech.level获取 / 设置
播报次数audio.speech.broadcastCount获取 / 设置
呼叫手机口令audio.voice.callPhone获取 / 设置
开灯口令audio.voice.light获取 / 设置
听令灵敏度audio.voice.sensitivity获取 / 设置
音量audio.volume.level获取 / 设置
视频编码格式控制media.codec.format获取 / 设置
音频编码media.codec.audioFormat获取 / 设置
码流设置media.codec.streamType获取 / 设置
设备支持几路码流media.codec.streamCount获取
码流自动切换media.codec.autoSwitch获取 / 设置
码流参数media.codec.bitrateParams获取
当前码流media.codec.currentBitrate获取 / 设置
视频分辨率每个I帧大小media.codec.iFrameSize获取
分辨率media.codec.resolution获取 / 设置
抓图码流media.codec.captureStream获取
拉流画面播放比例media.codec.playRatio获取
自动息屏时间media.display.autoOff获取 / 设置
自动亮屏media.display.autoWake获取 / 设置
夜间息屏media.display.nightOff获取 / 设置
夜间息屏时间段media.display.plan获取 / 设置
osd配置media.osd.config获取 / 设置
设备通道名称media.source.names获取 / 设置
视频通道信息media.source.order获取
水印media.watermark.enabled获取 / 设置
SIM卡信息network.cellular.info获取
SIM卡状态network.cellular.status获取
运营商名称network.cellular.operatorName获取
运营商信号(4g)network.cellular.operatorSignal获取
SIM卡APN配置状态network.cellular.apnStatus获取
蜂窝自动切换network.cellular.autoHandover获取 / 设置
蜂窝信号测试network.cellular.signalTest获取 / 设置
设置APN信息network.cellular.setApn调用
切换蜂窝网络network.cellular.switch调用
SIM能力network.sim.support仅发现
无感配网network.provisioning.insensitive仅发现
授权绑定network.provisioning.authBind仅发现
配件配对成功network.provisioning.accessoryPaired上报
配件网关network.gateway.accessory仅发现
蓝牙自发现network.bluetooth.selfDiscovery仅发现
DHCPnetwork.lan.dhcp获取 / 设置
设备局域网IP信息network.lan.ipInfo获取
联网方式network.link.mode获取
网络状态network.link.status获取
共享链路network.link.shared获取
共享链路支持先开音频对讲network.link.talkFirst获取
自动切换网络network.link.autoSwitch获取 / 设置
设备MAC信息network.link.macs获取
网络切换network.link.switch调用
单向连接network.link.oneWay仅发现
有线切 WiFinetwork.link.lanToWifi仅发现
ONVIFnetwork.service.onvif获取 / 设置
RTMPnetwork.service.rtmp获取 / 设置
RTMP配置network.service.rtmpConfig获取 / 设置
TLS加密network.service.tls获取 / 设置
设备发现network.service.discover获取 / 设置
三方接入network.service.thirdLink获取
设备标准RTSP服务端口(默认554)network.service.rtsp获取 / 设置
设备web服务端口(默认80)network.service.web获取
设备私有信令控制服务端口(默认37777)network.service.privateSignal获取 / 设置
设备私有信令控制服务基于TLS端口(默认37778)network.service.tlsSignal获取
设备私有拉流服务端口(默认8086)network.service.privateStream获取
wifi信息network.wifi.info获取
WIFI信号network.wifi.rssi获取 / 设置
信号频繁上报network.wifi.frequentReport获取 / 设置
支持WiFinetwork.wifi.support仅发现
Zigbee信号network.zigbee.rssi获取
电量信息(电池分类)power.battery.info获取
电池充电数据power.battery.chargeData获取
低电量报警(常规)power.battery.low上报
满电量告警power.battery.full上报
电量power.battery.level获取
用电模式power.mode.mode获取 / 设置
自动常电power.mode.autoConstant获取 / 设置
自动进入省电模式power.mode.autoSave获取 / 设置
进入功耗模式阈值power.mode.enterThreshold获取 / 设置
省电电量阀值power.mode.saveThreshold获取 / 设置
设备供电状态power.mode.supplyState获取
用电状态power.mode.state获取
VLog录制power.mode.vlog获取 / 设置
供电状态切换power.mode.switch调用
用电模式切换power.mode.changed上报
休眠状态power.sleep.status获取
预览休眠power.sleep.preview获取 / 设置
唤醒power.sleep.wake调用
延迟休眠power.sleep.delay调用
设备即将休眠事件power.sleep.imminent上报
当前功率power.outlet.power获取 / 设置
当前电流power.outlet.current获取 / 设置
当前电压power.outlet.voltage获取 / 设置
电量数据power.outlet.energy获取 / 设置
获取电参power.outlet.read调用
清除电量数据power.outlet.clearEnergy调用
按时间取操作统计power.outlet.statsByTime调用
隐私模式privacy.cover.enabled获取 / 设置
隐私模式计划时间段privacy.cover.plan获取 / 设置
隐私模式布防时间(时间点模式)privacy.cover.timePoints获取 / 设置
人形遮蔽开关privacy.mask.enabled获取 / 设置
人形遮蔽计划privacy.mask.plan获取 / 设置
门铃检测距离call.doorbell.distance获取 / 设置
设备对讲call.session.deviceTalk仅发现
通道对讲call.session.channelTalk仅发现
呼叫铃声静音call.session.ringMuted获取 / 设置
呼叫铃声音量call.session.ringVolume获取 / 设置
呼叫接听call.session.answer仅发现
呼叫挂断call.session.hangup仅发现
呼叫拒接call.session.refuse仅发现
呼入call.session.called上报
已接听call.session.answered上报
已挂断call.session.hungUp上报
已拒绝call.session.refused上报
已取消call.session.cancelled上报
双向视频对讲call.session.videoTalk仅发现
存储信息storage.local.capacity获取
存储容量细分storage.local.division获取
SD卡加密storage.local.encrypted获取 / 设置
SD卡格式化storage.local.format调用
存储卡异常报警storage.local.abnormal上报
存储卡拔出报警storage.local.removed上报
登入时间戳更新system.diagnostics.loginTime获取
最大在线时长system.diagnostics.maxOnline获取
设备启动状态system.diagnostics.state获取
心跳system.diagnostics.heartbeat上报
一键功能检测system.diagnostics.selfTest调用
设备启动system.diagnostics.booted上报
设备基本信息system.info.basic获取
设备型号system.info.model获取
名称system.info.name获取 / 设置
支持修改名称system.info.modifyName仅发现
三码合一system.credential.tcm仅发现
SC安全码system.credential.scCode仅发现
设备认证system.credential.auth仅发现
设备验证码system.credential.regCode仅发现
一键恢复默认配置system.maintenance.restore调用
日期格式system.time.format获取 / 设置
设备开始升级system.upgrade.started上报
设备升级成功system.upgrade.succeeded上报
设备升级失败system.upgrade.failed上报
升级进度上报system.upgrade.progressReport上报
已加载算法信息algorithm.package.loaded获取
算法包区域algorithm.package.region获取 / 设置
算法包升级algorithm.package.upgrade调用
算法校验algorithm.package.check调用
算法删除algorithm.package.delete调用
算法下载进度查询algorithm.package.progress调用
算法包状态algorithm.package.status调用
算法包开关查询algorithm.package.enable调用
算法包下载结果algorithm.package.downloadResult上报
算法包升级结果algorithm.package.upgradeResult上报
红外控制下发control.ir.send获取 / 设置
红外学习值control.ir.studyCode获取
红外自学习开关control.ir.studyEnabled获取 / 设置
红外学习失败control.ir.studyFailed上报
开关/通断control.outlet.enabled获取 / 设置
总开关control.outlet.masterEnabled获取 / 设置
开关第2路control.outlet.switch2Enabled获取 / 设置
开关第3路control.outlet.switch3Enabled获取 / 设置
开关第4路control.outlet.switch4Enabled获取 / 设置
开关第5路control.outlet.switch5Enabled获取 / 设置
开关第6路control.outlet.switch6Enabled获取 / 设置
童锁control.outlet.childLock获取 / 设置
过充保护control.outlet.overchargeProtection获取 / 设置
自动省电control.outlet.powerSaving获取 / 设置
开关次数control.outlet.switchCount获取 / 设置
多路重启状态control.outlet.restartState获取 / 设置
外接开关类型control.outlet.externalSwitchType获取 / 设置
开关工作模式control.outlet.operationMode获取 / 设置
点动脉冲时长control.outlet.pulseDuration获取 / 设置
多路开关control.outlet.multiControl获取 / 设置
设置倒计时control.outlet.countdownSet调用
获取倒计时control.outlet.countdownGet调用
设置定时器control.outlet.timerSet调用
获取定时器control.outlet.timerGet调用
定时器延时列表control.outlet.timerList调用
任务列表control.outlet.taskList调用
开关变更事件control.outlet.switched上报
第二路开关事件control.outlet.switch2Switched上报
第三路开关事件control.outlet.switch3Switched上报
功率过载control.outlet.overload上报
倒计时失败control.outlet.countdownFailed上报
倒计时完成control.outlet.countdownFinished上报
定时任务失败control.outlet.timerFailed上报
定时任务结束control.outlet.timerFinished上报
行程时间control.motor.runtime获取 / 设置
预设位置control.motor.preset获取 / 设置
窗帘关闭比例control.motor.travelPercent获取 / 设置
挡位状态控制control.motor.stateControl获取 / 设置
行程校准control.motor.calibrate获取 / 设置
门锁开关状态control.lock.status获取 / 设置
门锁状态control.lock.state获取
门锁控制control.lock.invoke调用
电机转向读取control.motor.directionGet调用
电机转向设置control.motor.directionSet调用
窗帘机控制control.motor.invoke调用
电池相机
device.capability.list(查询可用能力)