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

Modify Device Alarm Plan - Configure Motion Inspection Plans - Imou Open Platform

modifyDeviceAlarmPlan: Configure device alarm plan

Function details

Configure the device alarm plan.

Request address

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

Minimum permissions required for sub-account token request

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

Incoming parameter description

Parameter name Parameter type Is it required? Default value Legal value Parameter description
token String Yes Administrator or sub-account accessToken
deviceId String Yes Device serial number
channelId String Yes Channel number
rules period String Yes Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. You can also use "Monday, Wednesday, Friday" to select multiple options Repeat period
beginTime String Yes The time format is HH:mm:ss Start time
endTime String Yes The time format is HH:mm:ss End time

Sample input

{
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"b17b34edaa0d68ab7590fea2ca45f051",
        "time":1603356648,
        "nonce":"1f62152b-074b-45cd-b9b6-2b00117db8f3"
    },
    "id":"63d9e876-e223-481c-9886-6386d57556da",
    "params":{
        "rules":[
            {
                "period":"Monday",
                "beginTime":"00:00:00",
                "endTime":"23:59:59"
            },
            {
                "period":"Tuesday",
                "beginTime":"00:00:00",
                "endTime":"23:59:59"
            }
        ],
        "deviceId":"TESTQWERXXXX",
        "channelId":"0",
        "token":"At_00000ad9e6e87f0142eb92e207aec46a"
    }
}

Return data field description

No data returned

Sample output

{
  "result":{
    "msg":"The operation was successful.",
    "code":"0"
    },
    "id":"63d9e876-e223-481c-9886-6386d57556da"
}
deviceAlarmPlan: Get the motion inspection plan
setDeviceAlarmSensitivity: Set motion detection sensitivity