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
          • detection.motion.enabled (Read motion detection switch)
          • detection.motion.enabled (Set motion detection switch)
          • detection.motion.sensitivity (Read motion sensitivity)
          • detection.motion.sensitivity (Set motion sensitivity)
          • detection.motion.range (Read detection range)
          • detection.motion.range (Set detection range)
          • detection.motion.distance (Read detection distance)
          • detection.motion.distance (Set detection distance)
          • detection.motion.region (Read detection region)
          • detection.motion.region (Set detection region)
          • detection.motion.maxRange (Read max detection region extent)
          • detection.motion.plan (Read detection schedule)
          • detection.motion.plan (Set detection schedule)
          • detection.motion.tracking (Read motion tracking)
          • detection.motion.tracking (Set motion tracking)
          • detection.motion.metadata (Read motion alarm metadata)
          • detection.motion.detected (Motion detection alarm)
        • 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.motion.detected (Motion detection alarm)

detection.motion.detected: Motion detection alarm

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

What it does

Reported when motion is detected. Compose event: multiple sources merge into msgType detection.motion.detected; outputData follows the device ({} or extendContext only on some models). Subscribe to capabilityEvent in callbackFlag. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload.

Reported fields

Fields below may appear in outputData (not on every push). Motion pushes often include thumbnails, alarm images, optional token for linked cloud recording, and AI copy/tags when enabled. See Receive device messages.

NameDescriptionTypeRequiredValues
extendContextExtended context.structnocontains handleBit
extendContext.handleBitProcessing mask. Range 0–999, step 1.intno0–999, step 1

Example

Typical empty business payload:

{
 "msgType": "detection.motion.detected",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {},
 "time": 1673406989,
 "localTime": "20230111T111629",
 "alarmId": "116257862023505xxxx"
}

Some models include extendContext:

{
 "msgType": "detection.motion.detected",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {
 "extendContext": {
 "handleBit": 1
 }
 },
 "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"
 ],
 "labelType": "humanAlarm",
 "aiCopyWriting": "A man in black clothing rode past the store",
 "securityRiskLevel": 1,
 "aiTag": ["person", "vehicle"]
}

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.Motion detection。

detection.motion.metadata (Read motion alarm metadata)
detection.occlusion.enabled (Read video occlusion switch)