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

Set Device Alarm Region - Configure Motion Detection Area - Imou Open Platform

setDeviceAlarmRegion: Set the motion detection area

Function details

Set the motion detection area.

Request address

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

Minimum permissions required for sub-account token request

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

Incoming parameter description

Parameter nameParameter typeRequired or notDefault valueLegal valueParameter description
tokenStringYesAdministrator or sub-account accessToken
deviceIdStringYesDevice serial number
channelIdStringYesChannel ID
regionStringYesMotion detection region

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 • There are as many 32-bit integers as there are lines in the screen. If the number of integers is less than the number of lines, it is filled with 0 by default. If the number of lines exceeds the number of lines, the excess number will be discarded.

Sample input

{
  "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
  "system":{
    "ver":"1.0",
    "appId":"lcdxxxxxxxxx",
    "sign":"74bc756ebd53e9eef2836f8cf1730c10",
    "time":1599031074,
    "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
  },
  "params":{
    "token":"At_00006acr3456d12312d3grf60147de7ec",
    "deviceId":"TESTQWERXXXX",
    "channelId":"0",
    "region":"4194303,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384,3216384"
  }
}

Return data field description

No data returned

Sample output

{
     "result":{
         "msg":"The operation was successful.",
         "code":"0"
     },
     "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}
setDeviceAlarmSensitivity: Set motion detection sensitivity
getDeviceAlarmParam: Get device motion detection parameters