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
        • Loitering
        • Minor detection
        • Person and vehicle mix
        • Motion detection
        • Video occlusion
          • detection.occlusion.enabled (Read video occlusion switch)
          • detection.occlusion.enabled (Set video occlusion switch)
          • detection.occlusion.sensitivity (Read video occlusion sensitivity)
          • detection.occlusion.sensitivity (Set video occlusion sensitivity)
          • detection.occlusion.detected (Video occlusion detected)
        • 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.occlusion.detected (Video occlusion detected)

detection.occlusion.detected: Video occlusion detected

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

What it does

Standard pushes use capabilityEvent and this page’s msgType; some models may also emit legacy msg_type values—see device.capability.list and the event catalog.

Reported when video occlusion is detected. The push sets msgType to detection.occlusion.detected. Subscribe to capabilityEvent in callbackFlag. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload.

Reported fields

No extra business fields. Platform fields and thumbnails: Overview and common payload, Receive device messages.

Example

{
 "msgType": "detection.occlusion.detected",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {},
 "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.Video occlusion。

detection.occlusion.sensitivity (Set video occlusion sensitivity)
detection.parking.enabled (Read illegal parking switch)