deviceAlarmPlan (Get Device Alarm Plan - Imou Open Platform)

deviceAlarmPlan: Get Device Alarm Plan - Imou Open Platform

Deprecated: Use Motion detection plan (detection.motion.plan). This legacy HTTP page is retained for existing integrations.

Function details

Obtain the equipment alarm plan.

Request address

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

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

The minimum permissions required for sub-account token request

Sub-account accessToken policy must include Config; channel-scoped resource URI cam:{deviceId}:{channelId}. See Permission codes.

Incoming parameter description

Parameter name	Parameter type	Required or not	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": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "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	Type	Description
channelId	String	Channel number
rules.enable	Boolean	Whether the motion inspection plan is effective, true: effective, false: not effective
rules.beginTime	String	Start time, the time format is HH:mm:ss
rules.endTime	String	End time, the time format is HH:mm:ss
rules.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"
}

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.