Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
        • Arming
        • Attention zone
        • People counting
        • Cry detection
        • Absence from post
        • Face recognition
        • Fall detection
        • Gesture call
        • Intrusion
          • detection.intrusion.enabled (Read intrusion motion-detection switch)
          • detection.intrusion.enabled (Set intrusion motion-detection switch)
          • detection.intrusion.personFilter (Read human filter)
          • detection.intrusion.personFilter (Set human filter)
          • detection.intrusion.vehicleFilter (Read vehicle filter)
          • detection.intrusion.vehicleFilter (Set vehicle filter)
          • detection.intrusion.petFilter (Read pet filter)
          • detection.intrusion.petFilter (Set pet filter)
          • detection.intrusion.region (Read scene-change intrusion region)
          • detection.intrusion.region (Set scene-change intrusion region)
          • detection.intrusion.maxRange (Read intrusion region max range)
          • detection.intrusion.sensitivity (Read intrusion sensitivity)
          • detection.intrusion.sensitivity (Set intrusion sensitivity)
          • detection.intrusion.plan (Read intrusion arming schedule)
          • detection.intrusion.plan (Set intrusion arming schedule)
          • detection.intrusion.delete (Delete intrusion region)
          • detection.intrusion.rename (Rename intrusion region)
          • detection.intrusion.detected (Intrusion detection alarm)
        • Loitering
        • Minor detection
        • Person and vehicle mix
        • Motion detection
        • Video occlusion
        • Illegal parking
        • Person detection
        • Pet detection
        • PIR
        • License plate recognition
        • Vehicle guard
        • Siren
        • Voice SOS
        • Abnormal sound
        • Tripwire
        • Unoccupied detection
        • Vehicle
        • Door contact
        • Tamper
        • Gate accessory
        • Environment sensing
        • Target detection frame
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Reported fields
Example
Minimum permission

detection.intrusion.detected (Intrusion detection alarm)

detection.intrusion.detected: Intrusion detection alarm

detection.intrusion.detected · Channel scope · Message query permission Alarm

What it does

Reported when intrusion triggers. The uplink msgType is detection.intrusion.detected. Subscribe to capabilityEvent in callbackFlag. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload.

Reported fields

Fields inside outputData. Platform fields: Overview and common payload.

NameDescriptionTypeRequiredValues
regionTriggered region as a text coordinate string matching configured regions (not the array JSON from region configuration).textnostring
unlockTypeUnlock method.textnostring
keyIdKey ID.textnostring
keyNameKey name.textnostring
locationLocation.textnostring
phonePhone number.textnostring

Example

{
 "msgType": "detection.intrusion.detected",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {
 "region": "0,0,8192,8192",
 "unlockType": "example",
 "keyId": "example",
 "keyName": "example",
 "location": "example",
 "phone": "example"
 },
 "time": 1673406989,
 "localTime": "20230111T111629",
 "alarmId": "116257862023505xxxx",
 "token": "f2dc8c09eeae4b5bad6abf522c93d825",
 "thumbUrl": "https://example.imou.com/pic/thumb.jpg",
 "picUrlArray": [
 "https://example.imou.com/pic/frame1.jpg",
 "https://example.imou.com/pic/frame2.jpg"
 ]
}

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the alarm-message permission. A bound sub-user does not. A sub-account needs Alarm. list/search filters out events you are not allowed to see. Intrusion.

detection.intrusion.rename (Rename intrusion region)
detection.loitering.enabled (Read loitering detection switch)