旧版协议

旧版协议

何时使用（遗留）

本组接口仍通过 POST /openapi/{method} 调用，供已有集成维护。字段与返回码以各方法页为准。

新接入建议

优先使用设备能力与设备 API。仅在方法页明确写「继续旧调用」时保留本组 HTTP。

接口索引

本区 HTTP 接口供已有对接继续调用。新接入请勿选用。

请从能力使用与设备 API 选型。直播、云存、账号、绑定/解绑见 API 参考当前模块，不在本旧版区。

设备消息回调见推送配置与接收设备消息。

设备查询

API	Status	Recommended entry
checkDeviceBindOrNot	已有新接口	是否已绑定 (`device.bindstate.get`)
deviceOnline	已有新接口	查询在离线 (`device.status.get`)
listDeviceDetailsByIds	已有新接口	按 ID 批量详情 (`device.detail.list`)
listDeviceDetailsByPage	已有新接口	分页设备详情 (`device.detail.page`)
unBindDeviceInfo	已有新接口	绑定前信息 (`device.prebind.get`)
upgradeProcessDevice	已有新接口	升级进度 (`device.upgrade.process`)

平台设备 / easy4ip / 分享（遗留 HTTP）

API	说明	相关入口
bindDeviceChannelInfo	遗留 HTTP	设备 API 总览
bindDeviceInfo	遗留 HTTP	设备 API 总览
bindDeviceList	遗留 HTTP	按 ID 批量详情
deviceBaseDetailList	遗留 HTTP	分页设备详情
deviceBaseList	遗留 HTTP	分页设备详情
deviceList	遗留 HTTP	分页设备详情
deviceOpenDetailList	遗留 HTTP	设备 API 总览
deviceOpenList	遗留 HTTP	设备 API 总览
queryBaseDeviceChannelInfo	遗留 HTTP	设备 API 总览
queryOpenDeviceChannelInfo	遗留 HTTP	设备 API 总览
shareDeviceList	遗留 HTTP	分页设备详情
deviceVersionList	遗留 HTTP	设备 API 总览
listDeviceAbility	遗留 HTTP	设备 API 总览

设备消息

API	Status	Recommended entry
deleteAlarmMessage	遗留 HTTP	告警消息 (`device.message.delete`)
getAlarmMessage	遗留 HTTP	告警消息 (`device.message.list`)
getAlarmMessageById	遗留 HTTP	告警消息 (`device.message.detail`)

门锁与门铃

API	Status	Recommended entry
deleteDoorKey	遗留 HTTP	门磁与门锁 (`detection.door`)
doorbellCallAnswer	遗留 HTTP	门铃 (`call.doorbell`)
doorbellCallHangUp	遗留 HTTP	门铃 (`call.doorbell`)
doorbellCallRefuse	遗留 HTTP	门铃 (`call.doorbell`)
generateSnapkey	遗留 HTTP	门磁与门锁 (`detection.door`)
getDevicePowerInfo	遗留 HTTP	门磁与门锁 (`detection.door`)
getDoorKeys	遗留 HTTP	门磁与门锁 (`detection.door`)
getOpenDoorRecord	遗留 HTTP	门磁与门锁 (`detection.door`)
getSnapkeyList	遗留 HTTP	门磁与门锁 (`detection.door`)
openDoorRemote	遗留 HTTP	门磁与门锁 (`detection.door`)
wakeUpDevice	遗留 HTTP	门磁与门锁 (`detection.door`)

设备维护

API	Status	Recommended entry
modifyDeviceName	已有新接口	修改设备名称 (`device.name.set`)
modifyPassword	已有新接口	修改设备密码 (`device.password.set`)
refreshDeviceCover	已有新接口	刷新封面 (`device.cover.refresh`)
uploadDeviceCoverPicture	已有新接口	刷新封面 (`device.cover.refresh`)
upgradeDevice	已有新接口	触发升级 (`device.upgrade.execute`)
verifyPassword	已有新接口	校验设备密码 (`device.password.verify`)

设备操作

API	Status	Recommended entry
calibrationDeviceTime	已有新接口	平台校时 (`device.time.sync`)
controlLocationPTZ	已有新接口	云台转速/定位 (`ptz.aim.speed`)
controlMovePTZ	已有新接口	云台相对移动 (`ptz.aim.relative`)
controlPTZ	遗留 HTTP	云台相对移动 (`device.service.invoke`)
devicePTZInfo	已有新接口	云台转速/定位 (`ptz.aim.speed`)
getDeviceTime	已有新接口	读设备 UTC 时钟 (`device.time.get`)
restartDevice	已有新接口	重启设备 (`device.reboot.execute`)

设备使能

API	Status	Recommended entry
breathingLightStatus	已有新接口	设备指示灯 (`light.indicator.enabled`)
getDeviceCameraStatus	遗留 HTTP	能力使用 (`device.property.get`)
modifyBreathingLight	遗留 HTTP	设备指示灯 (`light.indicator.enabled`)
setDeviceCameraStatus	遗留 HTTP	能力使用 (`device.property.set`)

移动检测

API	Status	Recommended entry
deviceAlarmPlan	已有新接口	检测时间段 (`detection.motion.plan`)
getDeviceAlarmParam	已有新接口	移动检测参数 (`detection.motion.plan`)
modifyDeviceAlarmPlan	已有新接口	检测时间段 (`detection.motion.plan`)
modifyDeviceAlarmStatus	已有新接口	移动检测 (`detection.motion.enabled`)
setDeviceAlarmRegion	已有新接口	检测区域 (`detection.motion.region`)
setDeviceAlarmSensitivity	已有新接口	动检灵敏度 (`detection.motion.sensitivity`)

收藏点

API	Status	Recommended entry
deleteCollection	已有新接口	删除收藏点 (`ptz.preset.delete`)
getCollection	已有新接口	获取收藏点 (`ptz.preset.list`)
modifyCollection	已有新接口	重命名收藏点 (`ptz.preset.rename`)
setCollection	已有新接口	添加收藏点 (`ptz.preset.add`)
turnCollection	已有新接口	转到收藏点 (`ptz.preset.goto`)

定时巡航

API	Status	Recommended entry
getTimeCruisePlan	遗留 HTTP	巡航 (`ptz.cruise.*`)
setTimeCruisePlan	遗留 HTTP	巡航 (`ptz.cruise.*`)

本地录像配置

API	Status	Recommended entry
queryLocalRecordPlan	已有新接口	存储计划 (`record.plan.plan`)
queryLocalRecordStream	已有新接口	本地录像参数 (`record.plan.config`)
setLocalRecordPlan	遗留 HTTP	存储计划 (`record.plan.plan`)
setLocalRecordPlanRules	已有新接口	存储计划 (`record.plan.plan`)
setLocalRecordStream	已有新接口	本地录像参数 (`record.plan.config`)

音频

API	Status	Recommended entry
getSoundVolumeSize	已有新接口	音量 (`audio.volume.level`)
setSoundVolumeSize	已有新接口	音量 (`audio.volume.level`)

存储

API	Status	Recommended entry
deviceSdcardStatus	遗留 HTTP	本地存储容量 (`storage.local.capacity.storageState`)
deviceStorage	已有新接口	存储信息 (`storage.local.capacity`)
recoverSDCard	已有新接口	SD 卡格式化 (`storage.local.format`)

视频与成像

API	Status	Recommended entry
frameReverseStatus	已有新接口	画面翻转 (`image.orient.enabled`)
getFillLightSensitivity	已有新接口	补光灯灵敏度 (`light.fill.sensitivity`)
getNightVisionMode	已有新接口	夜视模式 (`image.night.mode`)
getZoomFocus	已有新接口	变焦倍数 (`ptz.zoom.value`)
modifyFrameReverseStatus	已有新接口	画面翻转 (`image.orient.enabled`)
queryDeviceOsd	已有新接口	OSD 配置 (`media.osd.config`)
setDeviceOsd	已有新接口	OSD 配置 (`media.osd.config`)
setFillLightSensitivity	已有新接口	补光灯灵敏度 (`light.fill.sensitivity`)
setNightVisionMode	已有新接口	夜视模式 (`image.night.mode`)
setZoomFocus	已有新接口	设置变倍聚焦 (`ptz.zoom.set`)

时区

API	Status	Recommended entry
getIotDeviceTimeZone	已有新接口	读时区 (`device.timezone.get`)
setIotDeviceTimeZone	已有新接口	写时区 (`device.timezone.set`)

Wi-Fi

API	Status	Recommended entry
controlDeviceWifi	已有新接口	连接或断开 Wi-Fi (`device.wifi.control`)
currentDeviceWifi	已有新接口	当前 Wi-Fi (`device.wifi.current`)
wifiAround	已有新接口	扫描周边热点 (`device.wifi.scan`)

本地录像查询

API	Status	Recommended entry
queryLocalRecordBitmap	遗留 HTTP	本地录像掩码 (`record.file.bitmap`)
queryLocalRecordNum	遗留 HTTP	本地录像总数 (`record.file.count`)
queryLocalRecords	已有新接口	获取本地录像 (`record.file.list`)