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

detection.motion.tracking (Set motion tracking)

detection.motion.tracking: Set motion tracking

detection.motion.tracking · Channel scope · Permission Config

What it does

Turns motion tracking on or off on this channel. 1 on, 0 off. Out-of-range values are rejected, not clamped.

Request URL

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

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. A write timeout does not mean the operation did not run.

Request parameters

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
channelIdStringyesChannel ID; "0" is common on IPCs
propertiesObjectyeskey is detection.motion.tracking
ValueDescription
0Off
1On

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.motion.tracking": 1
 }
 }
}

Response data fields

On success, code is "0" and data is {}.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {}
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Read motion tracking · Motion detection

detection.motion.tracking (Read motion tracking)
detection.motion.metadata (Read motion alarm metadata)