Event types
Event types
Subscribe to capabilityEvent via setMessageCallback to receive capability events (see Receive alarm messages). This table mirrors the Events overview Event types index (same msgType set); names link to capability event leaves. Full push samples (including the deviceId/outputData push payload) are on those capability pages. Legacy alarm / deviceStatus string msgType values are in Event message types; payload formats are in Event message format. Search with Search messages by type; one item with Query one alarm message.
| Event | ID | Key fields | Query | Receive |
|---|---|---|---|---|
| Algorithm package download result | algorithm.package.downloadResult | type, dwnResult, dwnResult.ret, dwnResult.url, url | Query | Receive |
| Algorithm package upgrade result | algorithm.package.upgradeResult | upgradeResult, type, upgradeResult.url, upgradeResult.ret, url | Query | Receive |
| Incoming call | call.session.called | modeType, index, callId, type, desc, shareLinkTalk | Query | Receive |
| Call answered | call.session.answered | modeType, index, callId, type, desc, forwardSeconds, backwardSeconds | Query | Receive |
| Call hung up | call.session.hungUp | modeType, index, callId, type, desc | Query | Receive |
| Call refused | call.session.refused | modeType, index, callId, type, desc, forwardSeconds, backwardSeconds | Query | Receive |
| Call cancelled | call.session.cancelled | none | Query | Receive |
| IR learn failed | control.ir.studyFailed | none | Query | Receive |
| Countdown failed | control.outlet.countdownFailed | chn, order | Query | Receive |
| Countdown finished | control.outlet.countdownFinished | chn, order, action | Query | Receive |
| Power overload | control.outlet.overload | none | Query | Receive |
| Second switch channel event | control.outlet.switch2Switched | switch | Query | Receive |
| Third switch channel event | control.outlet.switch3Switched | switch | Query | Receive |
| Switch state changed | control.outlet.switched | switch | Query | Receive |
| Timer task failed | control.outlet.timerFailed | chn, order | Query | Receive |
| Timer task finished | control.outlet.timerFinished | chn, order, action | Query | Receive |
| Arming mode changed | detection.arming.changed | mode | Query | Receive |
| Attention area detected | detection.attention.detected | none | Query | Receive |
| Feature image recognition result | detection.counting.picRecognized | pics | Query | Receive |
| Crying alarm event | detection.cry.detected | none | Query | Receive |
| Deadbolt jammed | detection.door.blocked | none | Query | Receive |
| Door closed alarm | detection.door.closed | none | Query | Receive |
| Door opened alarm | detection.door.opened | none | Query | Receive |
| Card unlock failed | detection.door.cardFailed | hard_id | Query | Receive |
| Fingerprint unlock failed | detection.door.fingerprintFailed | hard_id | Query | Receive |
| Lock high-temperature alarm | detection.door.highTemperature | none | Query | Receive |
| Lock duress alarm | detection.door.hijack | type, keyId | Query | Receive |
| Key inserted | detection.door.keyInserted | none | Query | Receive |
| Password unlock failed | detection.door.passwordFailed | hard_id | Query | Receive |
| Door unlock event (credential) | detection.door.unlockEvent | type, keyID, result, direction | Query | Receive |
| Absence from post detected | detection.duty.detected | region | Query | Receive |
| High humidity alarm | detection.environment.humidityHigh | none | Query | Receive |
| Low humidity alarm | detection.environment.humidityLow | none | Query | Receive |
| High temperature alarm (environment) | detection.environment.temperatureHigh | none | Query | Receive |
| Low temperature alarm | detection.environment.temperatureLow | none | Query | Receive |
| Face comparison | detection.face.detected | id, faces, snapFace, candidates, ptzInfo, isDuplicateRemove, address, passerby, passerby.uid | Query | Receive |
| Fall detected | detection.fall.detected | name | Query | Receive |
| Gate accessory — door closed | detection.gate.closed | none | Query | Receive |
| Door left open too long | detection.gate.leftOpen | none | Query | Receive |
| Gate accessory — door opened | detection.gate.opened | none | Query | Receive |
| Intrusion detection alarm | detection.intrusion.detected | region, unlockType, keyId, keyName, location, phone | Query | Receive |
| Loitering detected | detection.loitering.detected | region | Query | Receive |
| Minor detected | detection.minor.detected | none | Query | Receive |
| AI alert — mixed presence | detection.mix.detected | type | Query | Receive |
| Motion detection alarm | detection.motion.detected | extendContext, extendContext.handleBit | Query | Receive |
| Video occlusion detected | detection.occlusion.detected | none | Query | Receive |
| Illegal parking detected | detection.parking.detected | region | Query | Receive |
| Person detected (smart detection) | detection.person.detected | none | Query | Receive |
| Pet detected | detection.pet.detected | none | Query | Receive |
| PIR alarm cleared | detection.pir.cleared | none | Query | Receive |
| PIR detected | detection.pir.detected | none | Query | Receive |
| License plate recognition | detection.plate.detected | infos, infos.no, mainColor, subBrand, category, groupType | Query | Receive |
| Vehicle guard detected | detection.sentry.detected | region | Query | Receive |
| Siren momentary alarm | detection.siren.activated | none | Query | Receive |
| Voice SOS (generic) | detection.sos.detected | none | Query | Receive |
| Abnormal sound alarm event | detection.sound.detected | soundType | Query | Receive |
| Tripwire detected | detection.trip.detected | region | Query | Receive |
| No person present detected | detection.unmanned.detected | region | Query | Receive |
| Vehicle detected | detection.vehicle.detected | dhEventType, dhEventObject | Query | Receive |
| Low battery alarm (standard) | power.battery.low | type, elePercent | Query | Receive |
| Battery full alarm | power.battery.full | none | Query | Receive |
| Power mode changed | power.mode.changed | mode, battery, electric | Query | Receive |
| Device about to sleep | power.sleep.imminent | none | Query | Receive |
| Standard event delivery | record.event.detected | none | Query | Receive |
| Timelapse completed | record.timelapse.completed | none | Query | Receive |
| SD card abnormal alarm | storage.local.abnormal | errorCode | Query | Receive |
| SD card removed alarm | storage.local.removed | none | Query | Receive |
| Heartbeat | system.diagnostics.heartbeat | index | Query | Receive |
| Device booted | system.diagnostics.booted | none | Query | Receive |
| Device upgrade started | system.upgrade.started | none | Query | Receive |
| Upgrade progress report | system.upgrade.progressReport | upgrade_result | Query | Receive |
| Device upgrade succeeded | system.upgrade.succeeded | none | Query | Receive |
| Device upgrade failed | system.upgrade.failed | errCode | Query | Receive |
Configuration change reports
After you subscribe to capabilityEvent, configuration change reports in this catalog use msgType device.property.report. Query by the matching property propertyId; do not list with device.property.report.
| Description | ID | Related configuration | Query | Receive |
|---|---|---|---|---|
| Configuration change report | device.property.report | e.g. Privacy mode, Searchlight, White light, Siren state, Battery info | Query | Receive |
Binding, sharing, online/offline, and other types not in this table are in Event message types.
