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
The minimum permissions required for sub-account token request
Incoming parameter description
Sample input
Return data field description
Sample output

Get Device Alarm Plan - Imou Open Platform

deviceAlarmPlan: Get device alarm plan

Function details

Obtain the equipment alarm plan.

Request address

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

The 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

Sample input

{
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"6ccddbf82890273486b1d174fd580db0",
        "time":1603355564,
        "nonce":"799af85b-56d7-47df-b010-f9ff898048f1"
    },
    "id":"6a60a796-f5f9-44c3-aeef-67cd051df684",
    "params":{
        "deviceId":"TESTQWERXXXX",
        "channelId":"0",
        "token":"At_00000ad9e6e87f0142eb92e207aec46a"
    }
}

Return data field description

Field name Field type Field description
channelId String Channel number
rules enable Boolean Whether the motion inspection plan is effective, true: effective, false: not effective
beginTime String Start time, the time format is HH:mm:ss
endTime String End time, the time format is HH:mm:ss
period String Repeat cycle: Monday: every Monday, Tuesday: every Tuesday, Wednesday: every Wednesday, Thursday: every Thursday, Friday: every Friday, Saturday: every Saturday, Sunday: every Sunday

Sample output

{
  "result":{
    "msg":"The operation was successful.",
    "code":"0",
    "data":{
            "rules":[
                {
                    "period":"Monday",
                    "enable":true,
                    "beginTime":"00:00:00",
                    "endTime":"01:00:00"
                }
            ],
            "channelId":"0"
        }
    },
    "id":"6a60a796-f5f9-44c3-aeef-67cd051df684"
}
modifyDeviceAlarmStatus: Set the motion detection switch
modifyDeviceAlarmPlan: Configure motion inspection plan