detection.door.keyPeriod (Recurring password)

detection.door.keyPeriod: Recurring password

detection.door.keyPeriod · device scope · permission Config

What it does

Manage recurring passwords. Each call runs once. Smart-lock models often use struct inputData/outputData (cmd, key_id, schedule/password fields, code, etc.); follow capability list and payloads. Models with no fields may send {}.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Do not send channelId on device-scope capabilities. Mixing device and channel properties in one request returns DV2008. A timeout does not mean the action failed.

Request parameters

Name	Type	Required	Description
`token`	String	yes	Access token for an administrator, sub-user, or sub-account
`deviceId`	String	yes	Device serial number
`productId`	String	no	Optional. If sent and it does not match the device model → `DV2009`
`serviceId`	String	yes	`detection.door.keyPeriod`
`inputData`	Object	yes	Same shape as One-time password (`cmd`, `key_id`, etc.; model subset)

For common request fields and signing, see Signing conventions and Common request payload.

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "serviceId": "detection.door.keyPeriod",
 "inputData": { "cmd": 1, "key_id": 1 }
 }
}

Response data fields

Output is in result.data.outputData. Often includes code (result code; varies by model).

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": { "code": 0 }
 }
 }
}

Error codes

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.

Code	Meaning	Next step
`DV2003`	Capability not on device	Use `device.capability.list`
`DV2007`	`channelId` vs scope mismatch	Required for channel scope; omit for device scope
`DV2008`	Mixed device and channel in one call	Split the request
`DV2009`	`productId` mismatch	Omit or set actual model id
`DV2011`	No capability permission	See Permission codes

See Capability errors.

Door contact