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
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

detection.intrusion.enabled (Read intrusion motion-detection switch)

detection.intrusion.enabled: Read intrusion motion-detection switch

detection.intrusion.enabled · Channel scope · Permission Config

What it does

detection.intrusion.enabled shape varies by model (object vs scalar)—follow device.capability.list and read-back. Reads intrusion master detection switch on this channel (motion/human/vehicle). 0 off, 1 on. Separate from filter properties—see human filter and vehicle filter; enable detection before tuning filters.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008.

Request parameters

NameTypeRequiredDescription
tokenStringyesaccessToken for administrator, sub-user, or sub-account
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
channelIdStringyesChannel number; "0" is common on IPCs
propertiesArrayyes["detection.intrusion.enabled"]

Common request fields and the signature are in Development specification.

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "properties": [
 "detection.intrusion.enabled"
 ]
 }
}

Response data fields

The value is in result.data.properties["detection.intrusion.enabled"].

NameDescriptionTypeRequiredValues
motionMotion. 0 off, 1 on.intyes0 off; 1 on
personHuman. 0 off, 1 on.enumyes0 off; 1 on
vehicleVehicle. 0 off, 1 on.enumyes0 off; 1 on

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "detection.intrusion.enabled": {
 "motion": 0,
 "person": 0,
 "vehicle": 0
 }
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Set intrusion motion-detection switch · Intrusion

detection.gesture.enabled (Set gesture-call switch)
detection.intrusion.enabled (Set intrusion motion-detection switch)