Legacy APIs

When to use (legacy)

These methods still use POST /openapi/{method} for existing integrations. Fields and codes are on each method page.

Prefer Device capabilities and Device management APIs. Keep legacy HTTP only when the method page says so.

Older HTTP methods in this section remain callable for existing integrations. Do not choose them for new integrations.

Start from Capability usage and Device APIs. Live, cloud, account, and bind/unbind stay in the current API reference modules.

Device message callbacks are documented under Push configuration and Receive device messages.

API	Status	Recommended entry
checkDeviceBindOrNot	Superseded	Bind state (`device.bindstate.get`)
deviceOnline	Superseded	Query online status (`device.status.get`)
listDeviceDetailsByIds	Superseded	Batch detail by device ID (`device.detail.list`)
listDeviceDetailsByPage	Superseded	Paged device detail (`device.detail.page`)
unBindDeviceInfo	Superseded	Pre-bind information (`device.prebind.get`)
upgradeProcessDevice	Superseded	Upgrade progress (`device.upgrade.process`)

API	Notes	Related entry
bindDeviceChannelInfo	Legacy HTTP	Device APIs overview
bindDeviceInfo	Legacy HTTP	Device APIs overview
bindDeviceList	Legacy HTTP	Batch detail by device ID
deviceBaseDetailList	Legacy HTTP	Paged device detail
deviceBaseList	Legacy HTTP	Paged device detail
deviceList	Legacy HTTP	Paged device detail
deviceOpenDetailList	Legacy HTTP	Device APIs overview
deviceOpenList	Legacy HTTP	Device APIs overview
queryBaseDeviceChannelInfo	Legacy HTTP	Device APIs overview
queryOpenDeviceChannelInfo	Legacy HTTP	Device APIs overview
shareDeviceList	Legacy HTTP	Paged device detail
deviceVersionList	Legacy HTTP	Device APIs overview
listDeviceAbility	Legacy HTTP	Device APIs overview

API	Status	Recommended entry
deleteAlarmMessage	Legacy HTTP	Alarm messages (`device.message.delete`)
getAlarmMessage	Legacy HTTP	Alarm messages (`device.message.list`)
getAlarmMessageById	Legacy HTTP	Alarm messages (`device.message.detail`)

API	Status	Recommended entry
modifyDeviceName	Superseded	Rename device (`device.name.set`)
modifyPassword	Superseded	Change password (`device.password.set`)
refreshDeviceCover	Superseded	Refresh cover image (`device.cover.refresh`)
uploadDeviceCoverPicture	Superseded	Refresh cover image (`device.cover.refresh`)
upgradeDevice	Superseded	Trigger upgrade (`device.upgrade.execute`)
verifyPassword	Superseded	Verify password (`device.password.verify`)

API	Status	Recommended entry
calibrationDeviceTime	Superseded	Platform time sync (`device.time.sync`)
controlLocationPTZ	Superseded	PTZ aim (`ptz.aim.speed`)
controlMovePTZ	Superseded	PTZ relative move (`ptz.aim.relative`)
controlPTZ	Legacy HTTP	PTZ relative move (`device.service.invoke`)
devicePTZInfo	Superseded	PTZ aim (`ptz.aim.speed`)
getDeviceTime	Superseded	Read UTC clock (`device.time.get`)
restartDevice	Superseded	Reboot device (`device.reboot.execute`)

API	Status	Recommended entry
breathingLightStatus	Superseded	Device indicator (`light.indicator.enabled`)
getDeviceCameraStatus	Legacy HTTP	Capability usage (`device.property.get`)
modifyBreathingLight	Legacy HTTP	Device indicator (`light.indicator.enabled`)
setDeviceCameraStatus	Legacy HTTP	Capability usage (`device.property.set`)

API	Status	Recommended entry
deviceAlarmPlan	Superseded	Motion detection plan (`detection.motion.plan`)
getDeviceAlarmParam	Superseded	Motion detection (`detection.motion.plan`)
modifyDeviceAlarmPlan	Superseded	Motion detection plan (`detection.motion.plan`)
modifyDeviceAlarmStatus	Superseded	Motion detection (`detection.motion.enabled`)
setDeviceAlarmRegion	Superseded	Motion detection region (`detection.motion.region`)
setDeviceAlarmSensitivity	Superseded	Motion detection sensitivity (`detection.motion.sensitivity`)

API	Status	Recommended entry
getTimeCruisePlan	Legacy HTTP	Cruise (`ptz.cruise.*`)
setTimeCruisePlan	Legacy HTTP	Cruise (`ptz.cruise.*`)

API	Status	Recommended entry
queryLocalRecordPlan	Superseded	Recording plan (`record.plan.plan`)
queryLocalRecordStream	Superseded	Local recording parameters (`record.plan.config`)
setLocalRecordPlan	Legacy HTTP	Recording plan (`record.plan.plan`)
setLocalRecordPlanRules	Superseded	Recording plan (`record.plan.plan`)
setLocalRecordStream	Superseded	Local recording parameters (`record.plan.config`)

API	Status	Recommended entry
getSoundVolumeSize	Superseded	Volume (`audio.volume.level`)
setSoundVolumeSize	Superseded	Volume (`audio.volume.level`)

API	Status	Recommended entry
deviceSdcardStatus	Legacy HTTP	Local storage capacity (`storage.local.capacity.storageState`)
deviceStorage	Superseded	Local storage capacity (`storage.local.capacity`)
recoverSDCard	Superseded	Format SD card (`storage.local.format`)

API	Status	Recommended entry
frameReverseStatus	Superseded	Image orientation (`image.orient.enabled`)
getFillLightSensitivity	Superseded	Fill light (`light.fill.sensitivity`)
getNightVisionMode	Superseded	Night vision (`image.night.mode`)
getZoomFocus	Superseded	PTZ zoom (`ptz.zoom.value`)
modifyFrameReverseStatus	Superseded	Image orientation (`image.orient.enabled`)
queryDeviceOsd	Superseded	OSD (`media.osd.config`)
setDeviceOsd	Superseded	OSD (`media.osd.config`)
setFillLightSensitivity	Superseded	Fill light (`light.fill.sensitivity`)
setNightVisionMode	Superseded	Night vision (`image.night.mode`)
setZoomFocus	Superseded	PTZ zoom (`ptz.zoom.set`)

API	Status	Recommended entry
getIotDeviceTimeZone	Superseded	Read time zone (`device.timezone.get`)
setIotDeviceTimeZone	Superseded	Set time zone (`device.timezone.set`)

API	Status	Recommended entry
controlDeviceWifi	Superseded	Connect or disconnect Wi-Fi (`device.wifi.control`)
currentDeviceWifi	Superseded	Current Wi-Fi (`device.wifi.current`)
wifiAround	Superseded	Scan Wi-Fi hotspots (`device.wifi.scan`)

API	Status	Recommended entry
queryLocalRecordBitmap	Legacy HTTP	Local recording bitmap (`record.file.bitmap`)
queryLocalRecordNum	Legacy HTTP	Local recording count (`record.file.count`)
queryLocalRecords	Superseded	Local recording list (`record.file.list`)