Getting Started
Official Site
Getting Started
Official Site
  • Document description
  • Read before you start

  • Light application development guide

  • Mobile application development guide

  • Cloud live development guide

  • Desktop application development guide

  • Third party development guide

  • Message push development guide

  • IoT things data model

  • HTTP interface

    • Development specification
    • API privacy policy
    • Postman interface simulation call
    • accessToken: Get administrator token
    • API request example
    • Account docking
    • Push configuration
    • Cloud storage service
    • Equipment management

    • Device configurat

      • Device wifi configuration
      • Equipment dynamic inspection configuration
        • modifyDeviceAlarmStatus: Set the motion detection switch
        • deviceAlarmPlan: Get the motion inspection plan
        • modifyDeviceAlarmPlan: Configure motion inspection plan
        • setDeviceAlarmSensitivity: Set motion detection sensitivity
        • setDeviceAlarmRegion: Set the motion detection area
        • getDeviceAlarmParam: Get device motion detection parameters
      • Device storage configuration
      • Device enable configuration
      • Device collection point configuration
      • Device cruise configuration
      • Device video screen configuration
      • Device recording configuration
      • Device Operation
      • Daylight saving time configuration
    • Video equipment

    • Device message
    • Device live broadcast
    • Device lock access
  • Reference documents

On this page
Function details
Request address
Minimum permissions required for sub-account token request
Incoming parameter description
Sample input
Return data field description
Sample output

Get Device Motion Detection Parameters - Imou Open Platform

getDeviceAlarmParam: Get device dynamic detection parameters

Function details

Obtain equipment dynamic inspection parameters.

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/getDeviceAlarmParam

Minimum permissions required for sub-account token request

"Permission":"Config" "Resource":"cam:serial number:channel number"

Incoming parameter description

| Parameter name | Parameter type | Required or not | Default value | Legal value | Parameter description | | :------------- | :------------- | :-------------- | :------------ | :---------- | :--------------------------------------- | | | token | String | Yes | | | Administrator or sub-account accessToken | | deviceId | String | Yes | | | Device serial number | | channelId | String | Yes | | | Channel ID |

Sample input

{
  "system":{
    "ver":"1.0",
    "appId":"lcdxxxxxxxxx",
    "sign":"53306c63d849c3d89cd6de845513a509",
    "time":1603355808,
    "nonce":"8bdd6436-28c5-4237-9da9-c3188d5ed84d"
  },
  "id":"90ec9dd9-8081-47aa-8771-19904a5d3aa4",
  "params":{
    "deviceId":"TESTQWERXXXX",
    "channelId":"0",
    "token":"At_00000ad9e6e87f0142eb92e207aec46a"
  }
}

Return data field description

Field name Field type Field description
row Integer The number of rows in the dynamic detection area (read-only, device capability)
column Integer The number of columns in the dynamic detection area (read-only, device capability)
sensitive Integer Sensitivity, value range is [0, 100]
threshold Integer Area threshold, value range is [0, 100]
region String Motion inspection area

Remarks: region: Each line of the motion detection area is represented by a 32-bit integer. Each bit of the integer corresponds to a unit block of the screen. 0 indicates the non-motion detection area, 1 indicates the motion detection area, and the left side of the screen corresponds to the high number of the number. • The corresponding relationship between the 32-bit integer and the coordinates of the motion detection screen is as follows: • Screen column: left --> right; corresponding digital digits: left (high) --> right (low) because there are only 22 columns in motion detection, corresponding to the low 22 digits of the number, and the high 10 digits are fixed with 0

Sample output

{
  "result":{
    "msg":"The operation was successful.",
    "code":"0",
        "data":{
            "stall":1,
            "column":22,
            "sensitive":5,
            "row":18,
            "threshold":5,
            "region":"4194303,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384"
        }
    },
    "id":"90ec9dd9-8081-47aa-8771-19904a5d3aa4"
}
setDeviceAlarmRegion: Set the motion detection area
recoverSDCard: Device SD Card Format