modifyDeviceAlarmPlan (Modify Device Alarm Plan - Configure Motion Inspection Plans - Imou Open Platform)
modifyDeviceAlarmPlan: Modify Device Alarm Plan - Configure Motion Inspection Plans - Imou Open Platform
Deprecated: Use Motion detection plan (
detection.motion.plan). This legacy HTTP page is retained for existing integrations.
Function details
Configure the device alarm plan.
Request address
https://openapi-[DataCenter].easy4ip.com/openapi/modifyDeviceAlarmPlan
Request format
HTTP POST. JSON body layout: Request conventions. Sign with Signature.
Minimum permissions required for sub-account token request
The sub-account accessToken policy must include Config; channel resource URI is cam:{deviceId}:{channelId}. See Permission codes.
Incoming parameter description
rulesmay be omitted or an empty array (defaults to[]). At most 128 rules per request. Whenperiodisonce,beginTimeandendTimemust use%Y-%m-%d %H:%M:%S(for example2026-10-23 08:00:00).
| Parameter | Type | Required | Default | Legal value | 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 | |
| rules.beginTime | String | Yes | The time format is HH:mm:ss | Start time | |
| rules.endTime | String | Yes | The time format is HH:mm:ss | End time |
Sample input
{
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"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"
}
Error codes
This method may return the codes below. See Return codes and Capability errors for the full catalog.
Gateway and auth (SN / TK / OP)
| Code | Meaning | Next step |
|---|---|---|
SN1001 | Signature error | Check sign per Development specification |
TK1002 | Token invalid or expired | Refresh accessToken |
OP1002 | Missing required parameter | Add required fields |
OP1003 | Invalid parameter | Match this page’s parameter table |
OP1009 | Permission denied | Check token and device bind/share grants |
OP1013 | Total call limit exceeded | Reduce call rate |
OP1014 | Daily per-interface limit exceeded | See Interface call limits |
DV1007 | Device offline | Wait until the device is online |
See Return codes · OP/SN/TK for the full catalog.
Sub-accounts (SUB)
| Code | Meaning | Next step |
|---|---|---|
SUB1001–SUB1002 | Sub-account lacks API permission | Update policy via addPolicy |
SUB1005 | Sub-account token expired | Refresh subAccountToken |
SUB1006 | No device grant for sub-account | Check Resource and device serial |
SUB1008 | Sub-account not bound to app | Create and bind the sub-account first |
See Return codes · SUB.
Device access and channels (DV10xx)
| Code | Meaning | Next step |
|---|---|---|
DV1007 | Device offline or timeout | Wait for the device to come online |
DV1009 | Device busy | Retry later |
DV1012 | Insufficient share/grant permission | Check sub-account Permission / Resource |
DV1019 | Capability not supported | Confirm model and capability list |
DV1020 | Channel offline | Check channel status |
DV1026 | Function not supported | Use another API or upgrade firmware |
DV1028 | Not bound or channel missing | Verify deviceId / channelId |
See Return codes · DV.
