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
          • detection.arming.enabled (Read arming switch)
          • detection.arming.enabled (Set arming switch)
          • detection.arming.debounceDuration (Read alarm debounce duration)
          • detection.arming.debounceDuration (Set alarm debounce duration)
          • detection.arming.triggerInterval (Read event trigger interval)
          • detection.arming.triggerInterval (Set event trigger interval)
          • detection.arming.interval (Read alarm interval)
          • detection.arming.interval (Set alarm interval)
          • detection.arming.roles (Read local linkage roles)
          • detection.arming.linkedDevice (Read linked-device alarm)
          • detection.arming.linkedDevice (Set linked-device alarm)
          • detection.arming.changed (Arming mode changed)
          • detection.arming.mode (Read arming mode)
          • detection.arming.mode (Set arming mode)
          • detection.arming.leaveDelay (Read leave-home delay)
          • detection.arming.leaveDelay (Set leave-home delay)
          • detection.arming.applyMode (Apply arming mode)
          • detection.arming.queryMode (Query arming mode)
        • 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
        • 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.arming.queryMode (Query arming mode)

detection.arming.queryMode: Query arming mode

detection.arming.queryMode · Device scope · Permission Config

What it does

Query sub-device arming state by mode. Output configParams includes subSn and status (int 0/1).

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

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.Do not send channelId for device-scope capabilities.

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
serviceIdStringyesdetection.arming.queryMode
inputDataObjectyesSee table below
NameDescriptionTypeRequiredValues
modeMode to queryenumyes0 home; 1 away; 2 disarm

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": "<computed>",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTGW000012345",
 "serviceId": "detection.arming.queryMode",
 "inputData": { "mode": "1" }
 }
}

Output is in result.data.outputData (including configParams, etc.); see the table above.

Response data fields

NameDescriptionTypeRequiredValues
configParamsSub-device configuration listarrayno
configParams[].subSnSub-device IDtextyes
configParams[].statusStatusintyes0 disarm; 1 arm

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {
 "configParams": [
 { "subSn": "sub001", "status": 1 }
 ]
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Arming

detection.arming.applyMode (Apply arming mode)
detection.attention.detected (Attention zone detection)