1. API List

This section contains the APIs used for searching device alarm information.

API List:

No. Function Description
1 Get All Alarm Lists Search all the alarm information lists in the current user.
2 Get Alarm List according to Device Search the alarm list of the specified device.

1.1 Get All Alarm Lists

  • Function：

    Get all the alarm information lists in the current account.

  • Request Address

    {areaDomain}/api/lapp/alarm/list

  • Request Method

    POST

  • Request Parameters

Parameters Type Description Required
accessToken String The access_token obtained during authentication Y
startTime long Alarm search start time. The time format is 1457420564508, exactly on the second.By default, it starts at 0 on current day, and only data within 7 days can be searched N
endTime long Alarm search end time. The time format is 1457420564508, exactly on the second.By default, it ends at the current time. N
alarmType int Alarm type,by default, it is -1 (All) N
status int Alarm infromation status:2-All, 1- Read, 0- Unread, by default, it is 0 (Unread status) N
pageStart int Start page for paging,start with 0 and the default value is 0. N
pageSize int Page size,the default value is 10 and the maximum is 50. N
Alarm Type:
-1: All
10000:PIR Event
10001:Emergency Button Event
10002:Motion Detection Alarm
10003:Baby Cry Alarm
10004:Magnetic Contact Alarm
10005:Smoke Alarm
10006:Combustible Gas Alarm
10008:Water Leak Alarm
10009:Emergency Button Alarm
10010:PIR Alarm
10011:Video Tempering Alarm
10012:Video Loss
10013:Line Crossing
10014:Intrusion
10015:Face Detection Event
40001:Third-party Capture
40002:Connectivity
10016:Door Bell Ring Alarm
10018:Curtain Alarm
10019:Open-close Detector Alarm
10020:Scene Change Detection
10021:Defocus Detection
10022:Audio Exception Detection
10023:Unattended Baggage Detection
10024:Object Removal Detection
10025:Illegal Parking Detection
10026:People Gathering Detection
10027:Lotering Detection
10028:Fast Moving Detection
10029:Region Entrance Detection
10030:Region Exiting Detection
10031:Magnetic Disturbance Alarm
10032:Low Batter Alarm
10033:Intrusion Alarm
10035:Baby Motion Detection
10036:Switch Power Supply Alarm
10100:IO Alarm
10101:IO-1 Alarm
10102:IO-2 Alarm
10103:IO-3 Alarm
10104:IO-4 Alarm
10105:IO-5 Alarm
10106:IO-6 Alarm
10107:IO-7 Alarm
10108:IO-8 Alarm
10109:IO-9 Alarm
10110:IO-10 Alarm
10111:IO-11 Alarm
10112:IO-12 Alarm
10113:IO-13 Alarm
10114:IO-14Alarm
10115:IO-15 Alarm
10116:IO-16 Alarm
12000:Motion Detection Alarm
12001:Video Loss
12002:Video Tampering Alarm
12003:Instant Zone Alarm
12004:Instant Zone Alarm Recovered
12005:24-hour Voiced Zone Alarm
12006:24-hour Voiced Zone Alarm Recovered
12007:Delay Zone Alarm
12008:Delay Zone Alarm Recovered
12009:Internal Delayed Alarm
12010:Internal Delayed Alarm Recovered
12011:Fire Alarm Arming Zone Alarm
12012:Fire Alarm Arming Zone Alarm Recovered
12013:Behavior Analysis Alarm
12014:Behavior Analysis Alarm Recovered
12015:24 Hour Non-voiced Zone Alarm
12016:24 Hour Non-voiced Zone Alarm Recovered
12017:24 Hour Aux Zone Alarm
12018:24 Hour Aux Zone Alarm Recovered
12019:24 Hour Shock Zone Alarm
12020:24 Hour Shock Zone Alarm Recovered
12021:Sensor Tampered
12022:Sensor Tamper Recovered
12023:Soft Zone Emergency Alarm
12024:Soft Zone Fire Alarm
12025:Soft Zone Bandit Alarm
12026:Duress Report
12027:Device Tampering Alarm
12028:Device Tampering Alarm Recovered
12029:AC Power Off
12030:AC Power On
12031:Low Battery Voltage
12032:Battery Voltage Recovery
12033:Telephone Disconnected
12034:Telephone Connected
12035:Expansion Bus Module Offline
12036:Expansion Bus Module Online
12037:Keyboard Offline.
12038:Keyboard Recovered
12039:KBUS Trigger Disconnection
12040:KBUS Trigger Recovered
12041:Auto Arming/Disarming Failed
12042:Auto Disarming Failed
12043:Wireless Network Exception
12044:Wireless Network Recovery
12045:SIM Card Exception
12046:SIM Card Recovery
12047:Control Panel Reset
12048:Disarm
12049:Arm
12050:Auto Disarm
12051:Auto Arm
12052:Clear Alarm
12053:Instant Arm
12054:Key Region Disarming
12055:Key Region Arming
12056:Stay Arm
12057:Forced Arm
12058:Bypass
12059:Bypass Recovery
12060:Partition Group Bypass
12061:Partition Group Bypass Recovered
12062:Manual Test Report
12063:Scheduled Test Report
12064:Single-Zone Disarming
12065:Single-Zone Arming
12066:Keypad Locked
12067:Keypad Unlocked
12068:Printer Disconnected
12069:Printer Connected
12070:Instant Disarming
12071:Stay Disarming
12072:Scheduled to Enable the Trigger
12073:Scheduled to Disable the Trigger
12074:Failed to enable the trigger according to the schedule.
12075:Failed to disable the trigger according to the schedule.
12076:Enter Programming
12077:Exit Programming
12078:KBUS GP/K Disconnection
12079:KBUS GP/K Connection
12080:KBUS MN/K Disconnection
12081:KBUS MN/K Connected
12082:IP Conflicted
12083:Normal IP
12084:Network Disconnected
12085:Normal Network
12086:Motion Detection Alarm Stopped
12087:Video Tampering Detection Stopped
12088:Video Signal Recovered
12089:Input/Output Video Standard Mismatch
12090:Input/Output Video Format Recovered
12091:Video Input Exception
12092:Video Input Recovered
12093:HDD Full
12094:Free HDD
12095:HDD Error
12096:HDD Recovered
12097:Uploading Picture Failed
12098:Detector Offline
12099:Detector Online
12100:Detector Battery Low
12101:Detector Battery OK
12102:Zone Add Detector
12103:Zone Delete Detector
12104:Wi-Fi Exception
:Wi-Fi Recovered
12106:RF Exception
12107:RF Recovered
10037:Over_Temperature Alarm
10038:Low_Temperature Alarm
10039:Over_Humidity Alarm
10040:Low_Humidity Alarm
12108:Host Anti-tamper Alarm
12109:Host Anti-tamper Alarm Recovered
12110:Card Reader Anti-Tamper Alarm
12111:Card Reader Anti-Tamper Alarm Recovered
12112:Event Input Alarm
12113:Event Input Alarm Recovery
12114:Door Control Security Anti-Tamper Alarm
12115:Door Control Security Anti-Tamper Alarm Recovered
12116:Network Disconnected
12117:Network Connected
12118:Device Power On
12119:Device Power Off
12120:Door Abnormally Open

  • HTTP Request Message

    POST /api/lapp/alarm/list HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.47egoa5iazk02hcn73sepv2q12x8ulsx&startTime=&endTime=&alarmType=-1&status=2&pageStart=0&pageSize=3

  • Return Data

    {
  "page":{

      "total":9,
  "page":0,
  "size":3

    }, "data":[

      {
      "alarmId":"24027912025633491",
      "alarmName":"Device 1",
      "alarmType":10000,
      "alarmTime":4364654646485,
      "channelNo":1,
      "isEncrypt":0,
      "isChecked":0,
      "preTime":10,
      "delayTime":30,
      "deviceSerial":"427734888",
      "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455866402_724A2B55F5AFe741_06CE56000475452014644?isEncrypted=0&isCloudStored=0",
      "relationAlarms":[
      ],
      "customerType":null,
      "customerInfo":null
  },
  {
      "alarmId":"24027912025633469",
      "alarmName":"Device 2",
      "alarmType":10000,
      "alarmTime":4364654646485,
      "channelNo":1,
      "isEncrypt":0,
      "isChecked":0,
      "preTime":10,
      "delayTime":30,
      "deviceSerial":"427734777",
      "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455865753_B2B20A0FB4B45da2_06CE56000475437014644?isEncrypted=0&isCloudStored=0",
      "relationAlarms":[
      ],
      "customerType":null,
      "customerInfo":null
  },
  {
      "alarmId":"24027912025633457",
      "alarmName":"Device 3",
      "alarmType":10000,
      "alarmTime":4364654646485,
      "channelNo":1,
      "isEncrypt":0,
      "isChecked":0,
      "preTime":10,
      "delayTime":30,
      "deviceSerial":"427734666",
      "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455865563_0C0F2D84B18Ead68_06CE56000475431014644?isEncrypted=0&isCloudStored=0",
      "relationAlarms":[
      ],
      "customerType":null,
      "customerInfo":null
  }

    ], "code":"200", "msg":"Operation succeeded!" } </pre>

  • Return Filed：

Filed Name Type Description
alarmId String Aalrm Information ID
alarmName String Alarm source name
alarmType int Alarm type
alarmTime long Alarm time. The format is 2323452345, exactly on the millisecond
channelNo int Channel No.
isEncrypt int Encrypt?：0-No，1-Yes
isChecked int Read?0- No, 1- Yes
preTime int Pre-record time (s)
delayTime int Post-record time(s)
deviceSerial String Device serial No.
alarmPicUrl String Alarm picture address
relationAlarms list Linked alarm information
customerType String String Transparent Device Parameter Type
customerInfo String String Transparent Device Parameter Content
  • Return Code
Returned Code Returned Infromation Description
200 Operation succeeded. Requesting succeeded.
10001 Parameters error. Parameters are empty or the format is incorrect.
10002 accessToken exception or is expired. Get accessToken again.
10005 appKey exception. appKey is frozen.
49999 Data exception. Calling the API exception.

1.2Get Alarm Information List by Device

  • Function

    Get the device corresponding alarm information list.

  • Request Address

    {areaDomain}/api/lapp/alarm/device/list

  • Request Method

    POST

  • Request Parameters

Parameter Type Description Required
accessToken String The access_token during authentication. Y
deviceSerial String The device serial No.. Y
pageSize int Page size, the default value is 10 and the maximum is 50. N
pageStart int Start page for paging, start with 0 and the default value is 0. N
startTime long Alarm search start time. The time format is 1457420564508, exactly on the second. By default, it starts at 0 on current day, and only data within 7 days can be searched. N
endTime long Alarm search end time. The time format is 1457420564508, exactly on the second. By default, it ends at the current time. N
status int Alarm Information Status:2-All, 1- Read, 0- Unread, by default, it is 0 (Unread status) N
alarmType int Alarm type,by default, it is -1 (All) N
Alarm Type:
-1: All
10000:PIR Event
10001:Emergency Button Event
10002:Motion Detection Alarm
10003:Baby Cry Alarm
10004:Magnetic Contact Alarm
10005:Smoke Alarm
10006:Combustible Gas Alarm
10008:Water Leak Alarm
10009:Emergency Button Alarm
10010:PIR Alarm
10011:Video Tempering Alarm
10012:Video Loss
10013:Line Crossing
10014:Intrusion
10015:Face Detection Event
40001:Third-party Capture
40002:Connectivity
10016:Door Bell Ring Alarm
10018:Curtain Alarm
10019:Open-close Detector Alarm
10020:Scene Change Detection
10021:Defocus Detection
10022:Audio Exception Detection
10023:Unattended Baggage Detection
10024:Object Removal Detection
10025:Illegal Parking Detection
10026:People Gathering Detection
10027:Lotering Detection
10028:Fast Moving Detection
10029:Region Entrance Detection
10030:Region Exiting Detection
10031:Magnetic Disturbance Alarm
10032:Low Batter Alarm
10033:Intrusion Alarm
10035:Baby Motion Detection
10036:Switch Power Supply Alarm
10100:IO Alarm
10101:IO-1 Alarm
10102:IO-2 Alarm
10103:IO-3 Alarm
10104:IO-4 Alarm
10105:IO-5 Alarm
10106:IO-6 Alarm
10107:IO-7 Alarm
10108:IO-8 Alarm
10109:IO-9 Alarm
10110:IO-10 Alarm
10111:IO-11 Alarm
10112:IO-12 Alarm
10113:IO-13 Alarm
10114:IO-14Alarm
10115:IO-15 Alarm
10116:IO-16 Alarm
12000:Motion Detection Alarm
12001:Video Loss
12002:Video Tampering Alarm
12003:Instant Zone Alarm
12004:Instant Zone Alarm Recovered
12005:24-hour Voiced Zone Alarm
12006:24-hour Voiced Zone Alarm Recovered
12007:Delay Zone Alarm
12008:Delay Zone Alarm Recovered
12009:Internal Delayed Alarm
12010:Internal Delayed Alarm Recovered
12011:Fire Alarm Arming Zone Alarm
12012:Fire Alarm Arming Zone Alarm Recovered
12013:Behavior Analysis Alarm
12014:Behavior Analysis Alarm Recovered
12015:24 Hour Non-voiced Zone Alarm
12016:24 Hour Non-voiced Zone Alarm Recovered
12017:24 Hour Aux Zone Alarm
12018:24 Hour Aux Zone Alarm Recovered
12019:24 Hour Shock Zone Alarm
12020:24 Hour Shock Zone Alarm Recovered
12021:Sensor Tampered
12022:Sensor Tamper Recovered
12023:Soft Zone Emergency Alarm
12024:Soft Zone Fire Alarm
12025:Soft Zone Bandit Alarm
12026:Duress Report
12027:Device Tampering Alarm
12028:Device Tampering Alarm Recovered
12029:AC Power Off
12030:AC Power On
12031:Low Battery Voltage
12032:Battery Voltage Recovery
12033:Telephone Disconnected
12034:Telephone Connected
12035:Expansion Bus Module Offline
12036:Expansion Bus Module Online
12037:Keyboard Offline.
12038:Keyboard Recovered
12039:KBUS Trigger Disconnection
12040:KBUS Trigger Recovered
12041:Auto Arming/Disarming Failed
12042:Auto Disarming Failed
12043:Wireless Network Exception
12044:Wireless Network Recovery
12045:SIM Card Exception
12046:SIM Card Recovery
12047:Control Panel Reset
12048:Disarm
12049:Arm
12050:Auto Disarm
12051:Auto Arm
12052:Clear Alarm
12053:Instant Arm
12054:Key Region Disarming
12055:Key Region Arming
12056:Stay Arm
12057:Forced Arm
12058:Bypass
12059:Bypass Recovery
12060:Partition Group Bypass
12061:Partition Group Bypass Recovered
12062:Manual Test Report
12063:Scheduled Test Report
12064:Single-Zone Disarming
12065:Single-Zone Arming
12066:Keypad Locked
12067:Keypad Unlocked
12068:Printer Disconnected
12069:Printer Connected
12070:Instant Disarming
12071:Stay Disarming
12072:Scheduled to Enable the Trigger
12073:Scheduled to Disable the Trigger
12074:Failed to enable the trigger according to the schedule.
12075:Failed to disable the trigger according to the schedule.
12076:Enter Programming
12077:Exit Programming
12078:KBUS GP/K Disconnection
12079:KBUS GP/K Connection
12080:KBUS MN/K Disconnection
12081:KBUS MN/K Connected
12082:IP Conflicted
12083:Normal IP
12084:Network Disconnected
12085:Normal Network
12086:Motion Detection Alarm Stopped
12087:Video Tampering Detection Stopped
12088:Video Signal Recovered
12089:Input/Output Video Standard Mismatch
12090:Input/Output Video Format Recovered
12091:Video Input Exception
12092:Video Input Recovered
12093:HDD Full
12094:Free HDD
12095:HDD Error
12096:HDD Recovered
12097:Uploading Picture Failed
12098:Detector Offline
12099:Detector Online
12100:Detector Battery Low
12101:Detector Battery OK
12102:Zone Add Detector
12103:Zone Delete Detector
12104:Wi-Fi Exception
:Wi-Fi Recovered
12106:RF Exception
12107:RF Recovered
10037:Over_Temperature Alarm
10038:Low_Temperature Alarm
10039:Over_Humidity Alarm
10040:Low_Humidity Alarm
12108:Host Anti-tamper Alarm
12109:Host Anti-tamper Alarm Recovered
12110:Card Reader Anti-Tamper Alarm
12111:Card Reader Anti-Tamper Alarm Recovered
12112:Event Input Alarm
12113:Event Input Alarm Recovery
12114:Door Control Security Anti-Tamper Alarm
12115:Door Control Security Anti-Tamper Alarm Recovered
12116:Network Disconnected
12117:Network Connected
12118:Device Power On
12119:Device Power Off
12120:Door Abnormally Open

  • HTTP Request Report

    POST /api/lapp/alarm/list HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.47egoa5iazk02hcn73sepv2q12x8ulsx&deviceSerial=427734888&startTime=&endTime=&alarmType=-1&status=2&pageStart=0&pageSize=3

  • Return Data

    {
  "page":{

      "total":9,
  "page":0,
  "size":3

    }, "data":[

      {
      "alarmId":"24027912025633491",
      "alarmName":"Device 1",
      "alarmType":10000,
      "alarmTime":4364654646485,
      "channelNo":1,
      "isEncrypt":0,
      "isChecked":0,
      "preTime":10,
      "delayTime":30,
      "deviceSerial":"427734888",
      "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455866402_724A2B55F5AFe741_06CE56000475452014644?isEncrypted=0&isCloudStored=0",
      "relationAlarms":[
      ],
      "customerType":null,
      "customerInfo":null
  },
  {
      "alarmId":"24027912025633469",
      "alarmName":"Device 1",
      "alarmType":10000,
      "alarmTime":4364654646485,
      "channelNo":1,
      "isEncrypt":0,
      "isChecked":0,
      "preTime":10,
      "delayTime":30,
      "deviceSerial":"427734888",
      "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455865753_B2B20A0FB4B45da2_06CE56000475437014644?isEncrypted=0&isCloudStored=0",
      "relationAlarms":[
      ],
      "customerType":null,
      "customerInfo":null
  },
  {
      "alarmId":"24027912025633457",
      "alarmName":"Device 1",
      "alarmType":10000,
      "alarmTime":4364654646485,
      "channelNo":1,
      "isEncrypt":0,
      "isChecked":0,
      "preTime":10,
      "delayTime":30,
      "deviceSerial":"427734888",
      "alarmPicUrl":"https://wuhancloudpictest.ys7.com:8083/HIK_1455865563_0C0F2D84B18Ead68_06CE56000475431014644?isEncrypted=0&isCloudStored=0",
      "relationAlarms":[
      ],
      "customerType":null,
      "customerInfo":null
  }

    ], "code":"200", "msg":"Operation succeeded!" } </pre>

  • Return Filed

Filed Name Type Description
alarmId String Aalrm Information ID
alarmName String Alarm source name
alarmType int Alarm type
alarmTime long Alarm time. The format is 2323452345, exactly on the millisecond
channelNo int Channel No.
isEncrypt int Encrypt?：0-No，1-Yes
isChecked int Read?0- No, 1- Yes
preTime int Pre-record time (s)
delayTime int Post-record time(s)
deviceSerial String Device serial No.
alarmPicUrl String Alarm picture address
relationAlarms list Linked alarm information
customerType String String Transparent Device Parameter Type
customerInfo String String Transparent Device Parameter Content
  • Return Code
Returned Code Returned Infromation Description
200 Operation succeeded. Requesting succeeded.
10001 Parameters error. Parameters are empty or the format is incorrect.
10002 accessToken exception or is expired. Get accessToken again.
10005 appKey exception. appKey is frozen.
20002 Device does not exist.
20014 Illegal deviceSerial.
20018 The user does not have this device. Check whether the device belongs to the current account.
49999 Data exception. Calling the API exception.

results matching ""

    No results matching ""