Document maintenance notice
1.
Naming Rule
2.
Revision History
3.
Document update notice
API Reference
4.
Overview
5.
Common error code
6.
API
❱
6.1.
System
❱
6.1.1.
General
❱
6.1.1.1.
Range
6.1.1.2.
Get
6.1.1.3.
Set
6.1.2.
Date&Time
❱
6.1.2.1.
Range
6.1.2.2.
Get
6.1.2.3.
Set
6.1.3.
NTP
❱
6.1.3.1.
Range
6.1.3.2.
Get
6.1.3.3.
Set
6.1.4.
Output
❱
6.1.4.1.
Range
6.1.4.2.
Get
6.1.4.3.
Set
6.1.5.
DST
❱
6.1.5.1.
Range
6.1.5.2.
Get
6.1.5.3.
Set
6.1.6.
Channel Information
❱
6.1.6.1.
Get
6.1.7.
System Information
❱
6.1.7.1.
Get
6.1.8.
Record Information
❱
6.1.8.1.
Get
6.1.9.
Network State
❱
6.1.9.1.
Get
6.1.10.
Privacy Statement
❱
6.1.10.1.
Range
6.1.10.2.
Get
6.2.
Network
❱
6.2.1.
DDNS
❱
6.2.1.1.
Range
6.2.1.2.
Get
6.2.1.3.
Set
6.2.1.4.
Test
6.2.2.
Email
❱
6.2.2.1.
Range
6.2.2.2.
Get
6.2.2.3.
Set
6.2.2.4.
Test
6.2.3.
FTP
❱
6.2.3.1.
Range
6.2.3.2.
Get
6.2.3.3.
Set
6.2.3.4.
Test
6.2.4.
GBT28181
❱
6.2.4.1.
Range
6.2.4.2.
Get
6.2.4.3.
Set
6.2.5.
HTTPS
❱
6.2.5.1.
Range
6.2.5.2.
Get
6.2.5.3.
Set
6.2.6.
IP Filter
❱
6.2.6.1.
Range
6.2.6.2.
Get
6.2.6.3.
Set
6.2.7.
ipv6
❱
6.2.7.1.
Range
6.2.7.2.
Get
6.2.7.3.
Set
6.2.8.
Network Configuration
❱
6.2.8.1.
Network Base
❱
6.2.8.1.1.
Range
6.2.8.1.2.
Get
6.2.8.1.3.
Set
6.2.8.2.
WLAN
❱
6.2.8.2.1.
join
6.2.8.2.2.
MacthWiFiTypeSet
6.2.8.2.3.
Scan
6.2.8.2.4.
WifiStaParamSet
6.2.9.
Onvif
❱
6.2.9.1.
Range
6.2.9.2.
Get
6.2.9.3.
Set
6.2.10.
Rtsp
❱
6.2.10.1.
Range
6.2.10.2.
Get
6.2.10.3.
Set
6.2.11.
snmp
❱
6.2.11.1.
Range
6.2.11.2.
Get
6.2.11.3.
Set
6.2.12.
Tuya
❱
6.2.12.1.
Range
6.2.12.2.
Get
6.2.12.3.
Set
6.2.13.
Voice Assistant
❱
6.2.13.1.
Range
6.2.13.2.
Get
6.2.13.3.
Set
6.2.14.
IEEE8021x
❱
6.2.14.1.
Range
6.2.14.2.
Get
6.2.14.3.
Set
6.3.
Channel
❱
6.3.1.
Scheduled Tasks
❱
6.3.1.1.
Range
6.3.1.2.
Get
6.3.1.3.
Set
6.3.2.
Channel Configuration
❱
6.3.2.1.
Analog Channel
❱
6.3.2.1.1.
Range
6.3.2.1.2.
Get
6.3.2.1.3.
Set
6.3.2.2.
Broadcast IPC
❱
6.3.2.2.1.
Range
6.3.2.2.2.
Search
6.3.2.2.3.
Set
6.3.2.3.
Channel Configuration
❱
6.3.2.3.1.
Range
6.3.2.3.2.
Get
6.3.2.3.3.
Set
6.3.2.4.
IPChannel
❱
6.3.2.4.1.
Range
6.3.2.4.2.
Get
6.3.2.4.3.
Set
6.3.2.4.4.
AutoAddIPC
6.3.2.5.
Protocol Manage
❱
6.3.2.5.1.
Range
6.3.2.5.2.
Get
6.3.2.5.3.
Set
6.3.2.6.
Wireless Camera
❱
6.3.2.6.1.
Range
6.3.2.6.2.
Get
6.3.2.6.3.
Set
6.3.3.
Image Control
❱
6.3.3.1.
Range
6.3.3.2.
Get
6.3.3.3.
Set
6.3.3.4.
Default
6.3.4.
OSD
❱
6.3.4.1.
Range
6.3.4.2.
Get
6.3.4.3.
Set
6.3.5.
POE Power
❱
6.3.5.1.
Get
6.3.6.
PTZ
❱
6.3.6.1.
Range
6.3.6.2.
Get
6.3.6.3.
Set
6.3.7.
Remote Pair
❱
6.3.7.1.
Range
6.3.7.2.
Set
6.3.8.
ROI
❱
6.3.8.1.
Range
6.3.8.2.
Get
6.3.8.3.
Set
6.3.9.
Video Color
❱
6.3.9.1.
Range
6.3.9.2.
Get
6.3.9.3.
Set
6.3.9.4.
Default
6.3.10.
Video Cover
❱
6.3.10.1.
Range
6.3.10.2.
Get
6.3.10.3.
Set
6.3.11.
Video Crop
❱
6.3.11.1.
Range
6.3.11.2.
Get
6.3.11.3.
Set
6.4.
Stream
❱
6.4.1.
Encode
❱
6.4.1.1.
Range
6.4.1.2.
Get
6.4.1.3.
Set
6.4.2.
Capture
❱
6.4.2.1.
Range
6.4.2.2.
Get
6.4.2.3.
Set
6.4.3.
RTSP URL
❱
6.4.3.1.
Get
6.5.
Alarm
❱
6.5.1.
CombinationAlarm
❱
6.5.1.1.
Range
6.5.1.2.
Get
6.5.1.3.
Set
6.5.2.
CrossCounting
❱
6.5.2.1.
Range
6.5.2.2.
Get
6.5.2.3.
Set
6.5.3.
Disarming
❱
6.5.3.1.
Range
6.5.3.2.
Get
6.5.3.3.
Set
6.5.4.
Exception
❱
6.5.4.1.
Range
6.5.4.2.
Get
6.5.4.3.
Set
6.5.5.
FaceDetection
❱
6.5.5.1.
Range
6.5.5.2.
Get
6.5.5.3.
Set
6.5.6.
Flood-light
❱
6.5.6.1.
Range
6.5.6.2.
Get
6.5.6.3.
Set
6.5.6.4.
Default
6.5.7.
IntelligentAnalysis
❱
6.5.7.1.
Range
6.5.7.2.
Get
6.5.7.3.
Set
6.5.8.
IO Alarm
❱
6.5.8.1.
Range
6.5.8.2.
Get
6.5.8.3.
Set
6.5.9.
Line Crossing Detection
❱
6.5.9.1.
Range
6.5.9.2.
Get
6.5.9.3.
Set
6.5.10.
LinkageSchedule
❱
6.5.10.1.
Range
6.5.10.2.
Get
6.5.10.3.
Set
6.5.11.
Motion Alarm
❱
6.5.11.1.
Range
6.5.11.2.
Get
6.5.11.3.
Set
6.5.12.
Occlusion Detection
❱
6.5.12.1.
Range
6.5.12.2.
Get
6.5.12.3.
Set
6.5.13.
PedestrianDetection
❱
6.5.13.1.
Range
6.5.13.2.
Get
6.5.13.3.
Set
6.5.14.
Perimeter Intrusion Detection
❱
6.5.14.1.
Range
6.5.14.2.
Get
6.5.14.3.
Set
6.5.15.
PIR
❱
6.5.15.1.
Range
6.5.15.2.
Get
6.5.15.3.
Set
6.5.16.
PTZ Linkage
❱
6.5.16.1.
Range
6.5.16.2.
Get
6.5.16.3.
Set
6.5.17.
Sound Detection
❱
6.5.17.1.
Range
6.5.17.2.
Get
6.5.17.3.
Set
6.5.18.
Stationary Object Detection
❱
6.5.18.1.
Range
6.5.18.2.
Get
6.5.18.3.
Set
6.5.19.
VoiceAlarm
❱
6.5.19.1.
Range
6.5.19.2.
Get
6.5.19.3.
Set
6.5.19.4.
Import
6.5.19.5.
Delete
6.5.20.
VoicePrompts
❱
6.5.20.1.
Range
6.5.20.2.
Get
6.5.20.3.
Set
6.6.
Storage
❱
6.6.1.
Disk
❱
6.6.1.1.
Range
6.6.1.2.
Get
6.6.1.3.
Set
6.6.1.4.
Control
6.6.1.5.
Format
6.6.1.6.
Progress
6.6.2.
Disk Group
❱
6.6.2.1.
Range
6.6.2.2.
Get
6.6.2.3.
Set
6.6.3.
Cloud
❱
6.6.3.1.
Range
6.6.3.2.
Get
6.6.3.3.
Set
6.6.3.4.
accesstoken
6.6.3.5.
Control
6.6.4.
Audio
❱
6.6.4.1.
Range
6.6.4.2.
Get
6.6.4.3.
Set
6.6.5.
RAID
❱
6.6.5.1.
Range
6.6.5.2.
Get
6.6.5.3.
Set
6.7.
Record
❱
6.7.1.
Record Configuration
❱
6.7.1.1.
Range
6.7.1.2.
Get
6.7.1.3.
Set
6.7.2.
Search Record
❱
6.7.2.1.
Range
6.7.2.2.
Search
6.7.3.
Month Search
❱
6.7.3.1.
Get
6.7.4.
Pic Playback
❱
6.7.4.1.
Get
6.7.5.
Playback Page
❱
6.7.5.1.
Range
6.7.6.
Record Tag
❱
6.7.6.1.
Range
6.7.6.2.
Get
6.7.6.3.
Set
6.7.7.
Playback rtsp url
6.8.
Maintenance
❱
6.8.1.
Auto Reboot
❱
6.8.1.1.
Range
6.8.1.2.
Get
6.8.1.3.
Set
6.8.2.
DefoggingFan
❱
6.8.2.1.
Range
6.8.2.2.
Get
6.8.2.3.
Set
6.8.3.
DeveloperMode
❱
6.8.3.1.
Range
6.8.3.2.
Get
6.8.3.3.
Set
6.8.3.4.
Clear
6.8.3.5.
Download
6.8.3.6.
Token
6.8.4.
DeviceReboot
❱
6.8.4.1.
Set
6.8.5.
DeviceShutdown
❱
6.8.5.1.
Set
6.8.6.
FtpUpgrade
❱
6.8.6.1.
Range
6.8.6.2.
Get
6.8.6.3.
Set
6.8.6.4.
Check
6.8.6.5.
Progress
6.8.6.6.
Upgrade
6.8.7.
Import_Export Parameter
❱
6.8.7.1.
Get
6.8.7.2.
Set
6.8.8.
IPCMaintenance
❱
6.8.8.1.
FtpIpcUpgrade
❱
6.8.8.1.1.
Range
6.8.8.1.2.
Get
6.8.8.1.3.
Set
6.8.8.1.4.
Check
6.8.8.1.5.
Progress
6.8.8.1.6.
Upgrade
6.8.8.2.
IPCParamManagement
❱
6.8.8.2.1.
Export
6.8.8.2.2.
Get
6.8.8.2.3.
Import
6.8.8.2.4.
Range
6.8.8.3.
IPCReboot
❱
6.8.8.3.1.
Range
6.8.8.3.2.
Get
6.8.8.3.3.
Set
6.8.8.4.
IPCUpgrade
❱
6.8.8.4.1.
Range
6.8.8.4.2.
Get
6.8.8.4.3.
Token
6.8.8.4.4.
Upgrade
6.8.8.5.
Load Default
❱
6.8.8.5.1.
Range
6.8.8.5.2.
Get
6.8.8.5.3.
Set
6.8.8.6.
IPC Upgrade Code
6.8.9.
Load Default Parameter
❱
6.8.9.1.
Range
6.8.9.2.
Set
6.8.10.
Log
❱
6.8.10.1.
Range
6.8.10.2.
Search
6.8.11.
SystemUpgrade
❱
6.8.11.1.
ComponentToken
6.8.11.2.
ComponentVersionCheck
6.8.11.3.
Token
6.8.11.4.
ComponentUpgrade
6.8.11.5.
Upgrade
6.8.11.6.
VersionCheck
6.9.
Function
❱
6.9.1.
ANR
❱
6.9.1.1.
GetANRTimeInfo
6.9.1.2.
GetClientMac
6.9.1.3.
SetANRInfo
6.9.2.
ETR
❱
6.9.2.1.
Set
6.9.3.
Request I Frame
❱
6.9.3.1.
Range
6.9.4.
Snapshot
❱
6.9.4.1.
Get
6.9.4.2.
Range
6.10.
Event
❱
6.10.1.
Event_check&Event_push
❱
6.10.1.1.
Get&Push
6.10.2.
Http_listening
❱
6.10.2.1.
Get
6.10.2.2.
Range
6.10.2.3.
Set
6.10.3.
Http_listening_Push related description
❱
6.10.3.1.
get
❱
6.10.3.1.1.
Get
6.10.3.2.
keeplive
❱
6.10.3.2.1.
KeepLive
6.10.3.3.
post
❱
6.10.3.3.1.
POST
6.10.4.
Subscribe to api Design
6.11.
AI
❱
6.11.1.
Attribute_Detection
❱
6.11.1.1.
Range
6.11.1.2.
Get
6.11.1.3.
Set
6.11.2.
Cross_Counting_Scenario
❱
6.11.2.1.
Config
❱
6.11.2.1.1.
Get
6.11.2.1.2.
Set
6.11.2.2.
Image_Manage
❱
6.11.2.2.1.
Set
6.11.2.3.
Map
❱
6.11.2.3.1.
Get
6.11.2.3.2.
Set
6.11.2.4.
RealTime_Info
❱
6.11.2.4.1.
Get
6.11.2.4.2.
Set
6.11.2.5.
Statistics
❱
6.11.2.5.1.
Get
6.11.2.5.2.
Set
6.11.3.
Face Attendance(NVR dedicated)
❱
6.11.3.1.
Range
6.11.3.2.
Get
6.11.3.3.
Set
6.11.4.
Recongnition
❱
6.11.4.1.
Add Compare Face Image
❱
6.11.4.1.1.
Add
6.11.4.2.
Additional Face Image
❱
6.11.4.2.1.
Add
6.11.4.2.2.
Get
6.11.4.2.3.
GetById
6.11.4.2.4.
Remove
6.11.4.3.
Database face information query
❱
6.11.4.3.1.
GetByIndex
6.11.4.3.2.
GetById
6.11.4.3.3.
Search
6.11.4.3.4.
GetId
6.11.4.4.
Database license plate information query
❱
6.11.4.4.1.
GetCount
6.11.4.4.2.
GetById
6.11.4.4.3.
GetId
6.11.4.5.
Face
❱
6.11.4.5.1.
Add
6.11.4.5.2.
GetImagesFeature
6.11.4.5.3.
Modify
6.11.4.5.4.
Remove
6.11.4.6.
Face Group
❱
6.11.4.6.1.
Add
6.11.4.6.2.
Get
6.11.4.6.3.
GetId
6.11.4.6.4.
Modify
6.11.4.6.5.
Remove
6.11.4.6.6.
Change
6.11.4.7.
License Plate
❱
6.11.4.7.1.
Add
6.11.4.7.2.
Change
6.11.4.7.3.
Modify
6.11.4.7.4.
Remove
6.11.4.8.
License Plate Group
❱
6.11.4.8.1.
Add
6.11.4.8.2.
Get
6.11.4.8.3.
GetId
6.11.4.8.4.
Modify
6.11.4.8.5.
Remove
6.11.4.9.
Model Configuratuon
❱
6.11.4.9.1.
Get
6.11.4.9.2.
Set
6.11.4.10.
Snaped Faces and Objects Count Get (VHD)
❱
6.11.4.10.1.
Get
6.11.4.11.
Snaped Faces Search and Match
❱
6.11.4.11.1.
GetById
6.11.4.11.2.
GetByIndex
6.11.4.11.3.
Search
6.11.4.11.4.
StopSearch
6.11.4.12.
Snaped License Plates Search and Match
❱
6.11.4.12.1.
SearchPlate
6.11.4.13.
Snaped Objects Search
❱
6.11.4.13.1.
GetById
6.11.4.13.2.
GetByIndex
6.11.4.13.3.
Search
6.11.4.13.4.
StopSearch
6.11.5.
Repeat_Customer
❱
6.11.5.1.
FGet
6.11.5.2.
MGet
6.11.5.3.
SGet
6.11.6.
Setup
❱
6.11.6.1.
AI_Func_Schedule
❱
6.11.6.1.1.
Get
6.11.6.1.2.
Range
6.11.6.1.3.
Set
6.11.6.2.
Cross Counting
❱
6.11.6.2.1.
Get
6.11.6.2.2.
Range
6.11.6.2.3.
Set
6.11.6.3.
Crowd Density Detection
❱
6.11.6.3.1.
Get
6.11.6.3.2.
Range
6.11.6.3.3.
Set
6.11.6.4.
Face Detection
❱
6.11.6.4.1.
Get
6.11.6.4.2.
Range
6.11.6.4.3.
Set
6.11.6.5.
Heat Map
❱
6.11.6.5.1.
Get
6.11.6.5.2.
Range
6.11.6.5.3.
Set
6.11.6.6.
Human & Vehicle Detection
❱
6.11.6.6.1.
Get
6.11.6.6.2.
Range
6.11.6.6.3.
Set
6.11.6.7.
Intrusion
❱
6.11.6.7.1.
Get
6.11.6.7.2.
Range
6.11.6.7.3.
Set
6.11.6.8.
License Plate Detection
❱
6.11.6.8.1.
Get
6.11.6.8.2.
Range
6.11.6.8.3.
Set
6.11.6.9.
Line Crossing Detection
❱
6.11.6.9.1.
Get
6.11.6.9.2.
Range
6.11.6.9.3.
Set
6.11.6.10.
Queue Lenght Detection
❱
6.11.6.10.1.
Get
6.11.6.10.2.
Range
6.11.6.10.3.
Set
6.11.6.11.
Rare Sound Detection
❱
6.11.6.11.1.
Get
6.11.6.11.2.
Range
6.11.6.11.3.
Set
6.11.6.12.
Region_Entrance
❱
6.11.6.12.1.
Get
6.11.6.12.2.
Range
6.11.6.12.3.
Set
6.11.6.13.
Region_Exiting
❱
6.11.6.13.1.
Get
6.11.6.13.2.
Range
6.11.6.13.3.
Set
6.11.6.14.
Stationary Object Detection
❱
6.11.6.14.1.
Get
6.11.6.14.2.
Range
6.11.6.14.3.
Set
6.11.7.
Snaped_face_or_object
❱
6.11.7.1.
Get
6.11.8.
Statastics (NVR dedicated)
❱
6.11.8.1.
Cross Counting Statistics
❱
6.11.8.1.1.
Get
6.11.8.1.2.
Range
6.11.8.1.3.
Set
6.11.8.1.4.
Search
6.11.8.2.
Face Search
❱
6.11.8.2.1.
Get
6.11.8.2.2.
Search
6.11.8.3.
Heat Map Statistics
❱
6.11.8.3.1.
Get
6.11.8.3.2.
Range
6.11.8.3.3.
Set
6.11.8.3.4.
Search
6.11.8.4.
Hman & Vehicle Search
❱
6.11.8.4.1.
Get
6.12.
ExtendedFunctionality
❱
6.12.1.
AI Mutex Relation
❱
6.12.1.1.
Get
6.12.2.
IPCVoice Prompt
❱
6.12.2.1.
Get
6.12.2.2.
Set
6.12.3.
Mutex Relation
❱
6.12.3.1.
Get
6.13.
Push
❱
6.13.1.
Push
❱
6.13.1.1.
GetToken
6.13.1.2.
Query
6.13.1.3.
QueryDefault
6.13.1.4.
Subscribe
6.13.1.5.
Unsubscribe
6.13.2.
PushSubscribe
❱
6.13.2.1.
Get
6.13.2.2.
Set
6.14.
Thermal
❱
6.14.1.
Fire Detection
❱
6.14.1.1.
Add
6.14.1.2.
Delete
6.14.1.3.
Get
6.14.1.4.
Range
6.14.1.5.
Set
6.14.2.
Image Control
❱
6.14.2.1.
Default
6.14.2.2.
InfraredCorr
6.14.2.3.
Get
6.14.2.4.
Range
6.14.2.5.
Set
6.14.3.
Measurement
❱
6.14.3.1.
Get
6.14.3.2.
Range
6.14.3.3.
Set
6.14.4.
Measurement Rule
❱
6.14.4.1.
Add
6.14.4.2.
Delete
6.14.4.3.
Get
6.14.4.4.
Range
6.14.4.5.
Set
6.14.5.
Spot Measurement
❱
6.14.5.1.
Get
6.14.6.
Video Color
❱
6.14.6.1.
Default
6.14.6.2.
Get
6.14.6.3.
Range
6.14.6.4.
Set
6.15.
ConsumerInfo
❱
6.15.1.
Get
6.15.2.
Set
6.16.
Login
❱
6.16.1.
Account Rules
❱
6.16.1.1.
Get
6.16.2.
DevicePage
❱
6.16.2.1.
Get
6.16.2.2.
Pages
6.16.3.
FirstLogin
❱
6.16.3.1.
Password
❱
6.16.3.1.1.
Set
6.16.4.
Login
❱
6.16.4.1.
Heartbeat
6.16.4.2.
Range
6.16.4.3.
ChannelInfo
❱
6.16.4.3.1.
Get
6.16.4.4.
DeviceInfo
❱
6.16.4.4.1.
Get
6.16.5.
PreviewChannel
❱
6.16.5.1.
DualTalk
❱
6.16.5.1.1.
Get
6.16.5.1.2.
Set
6.16.5.2.
Floodlight2AudioAlarm
❱
6.16.5.2.1.
Get
6.16.5.2.2.
Set
6.16.5.3.
ManualAlarm
❱
6.16.5.3.1.
Get
6.16.5.3.2.
Set
6.16.5.4.
PTZ
❱
6.16.5.4.1.
Get
6.16.5.4.2.
Control
6.16.5.4.3.
Progress
6.16.6.
RecoverPassword
❱
6.16.6.1.
Get
6.16.6.2.
Set
6.16.6.3.
Range
6.16.6.4.
Authorization
❱
6.16.6.4.1.
Get
6.16.6.4.2.
Set
6.16.6.4.3.
Range
6.16.6.5.
Certificate
❱
6.16.6.5.1.
Export
6.16.6.6.
Email
❱
6.16.6.6.1.
Send
6.16.7.
Request pubkey or randbyte
❱
6.16.7.1.
README
6.16.7.2.
EncryptObjectTable
6.16.7.3.
Login
6.16.7.4.
Maintenance
6.16.8.
Web
❱
6.16.8.1.
Login
6.16.8.2.
Logout
6.17.
MutexParam
❱
6.17.1.
Get
7.
References
Light (default)
Rust
Coal
Navy
Ayu
HTTP API Protocol For IP Media Device
Document not found (404)
This URL is invalid, sorry. Please use the navigation bar or search to continue.