1. API List
This section introduces the device related APIs, including device operation, device search, device updating, PTZ control, alarm information search, detector operation, people counting operation, and switch status control, etc..
API List:
| No. | Function | Description |
|---|---|---|
| 1 | Add Device | Add the device to the account. |
| 2 | Delete Device | Delete the device in the account. |
| 3 | Edit Device Name | Edit the device name. |
| 4 | Capture Device Picture | Capture the device current pictures. |
| 5 | Link IPC to NVR Device | Link the IPC to NVR device. |
| 6 | Delete IPC in NVR Device | Delete the IPC in NVR device. |
| 7 | Get Device List | Get the device list for the login user. |
| 8 | Get Single Device Information | Get the device information. |
| 9 | Get Camera List | Get the camera list for the login user. |
| 10 | Search Captured Picture according to UUID | Search the captured pictures according UUID. |
| 11 | Get Device Version Information | Get the device version information. |
| 12 | Update Device Firmware | Update the device firmware |
| 13 | Get Device Updating Status | Get the device updating status, including updating |
| 14 | Start PTZ Control | Start PTZ control. |
| 15 | Stop PTZ Control | Stop PTZ control. |
| 16 | Mirror Flip | Mirror flipping. |
| 17 | Add Preset | Add the preset. |
| 18 | Call Preset | Call the preset. |
| 19 | Clear Preset | Clear the preset. |
| 20 | Get all Alarm Information List | Search the alarm information list for the current user. |
| 21 | Get Alarm List according to Device | Search the alarm list of the device. |
| 22 | Subscribe C Users' Alarm Message | Subscribe C users' device alarm messages in B mode administrator. |
| 23 | Cancel Subscription of C Users' Alarm Message | Cancel the subscription of C users' device alarm message in B mode administrator. |
| 24 | Get Detector List | Search the detector list linked to A1 series device. |
| 25 | Set Detector Status | Set to enable/disable arming or disarming detector. |
| 26 | Delete Detector | Delete the detector linked to A1 series device. |
| 27 | Get Enabled IPC List | Get the IPC list which can be linked to A1 series device. |
| 28 | Get Linked IPC List | Get the IPC list which has been linked to A1 series device. |
| 29 | Set Linkage between Detector and IPC | Set the linkage relationship between detector linked to A1 series device and IPC. |
| 30 | Get People Counting Status | Search the people counting status of the device. |
| 31 | Set People Counting Status | Set the people counting status for the device. |
| 32 | Search Device People Counting Statistics on Current Day | Search the device people counting statistics on the current day. |
| 33 | Search Device People Counting Statistics in Each Hour on Current Day | Search the device people counting statistics in each hour on the current day. |
| 34 | Set People Counting Infomration | Set the people counting information. |
| 35 | Get People Counting Configuration Information | Get the people counting configuration information. |
| 36 | Arm/Disarm Device | Set to enable/disable arming or disarming the device. |
| 37 | Disable Device Video Encryption | Disable the device video encryption. |
| 38 | Enable Device Video Encryption | Enable the device video encryption. |
| 39 | Get WiFi Settings/Audio Prompt Status | Get WiFi settings or audio prompt status for rebooting device. |
| 40 | Set WiFi Settings/Audio Prompt Status | Set WiFi settings or enable/disable audio prompt for rebooting device. |
| 41 | Get Lens Masked Status | Get the lens masked status. |
| 42 | Set Lens Masked Status | Set the lens masked status. |
| 43 | Get Sound Location Status | Get the sound location status. |
| 44 | Set Sound Location Status | Set to enable/disable sound location. |
| 45 | Get Arming/Disarming Schedule | Get the arming or disarming schedule (activity detection) . |
| 46 | Set Arming/Disarming Schedule | Set the arming or disarming schedule (activity detection) . |
| 47 | Edit Detector Name | Edit the detector name. |
| 48 | One-touch Clear Alarm for Device | The device clears the alarm remotely. |
| 49 | Get device status information | Get the specified device status information |
| 50 | Get device channel information | Get the information of device channel by device serial |