audio.dnd.plan (Set Do Not Disturb schedule)

audio.dnd.plan: Set Do Not Disturb schedule

audio.dnd.plan · Device scope · Permission Config

Feature details

Set up your device snooze schedule. Up to 5. Out of bounds rejection, not truncation.

Request address

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set

Administrators do not need permission to operate self-bound devices. Basic configuration permission is required to operate the shared device. Child user binding is not required. Sub-account requires Config. A write timeout does not mean that it was not executed.

Request parameters

Name	Type	Required	Description
`token`	String	yes	Administrator, sub-user, or sub-account accessToken
`deviceId`	String	yes	Device serial number
`productId`	String	no	Optional. If sent and it does not match the device model → `DV2009`
`properties`	Object	Yes	key is`audio.dnd.plan`, value is an array of objects (up to`5`items)
`properties["audio.dnd.plan"][].data`	`int`	yes	Time parameter: `0`–`999999`, step `1`
`properties["audio.dnd.plan"][].time`	`text`	yes	Start–end time, format `HH:mm-HH:mm`
`properties["audio.dnd.plan"][].status`	`enum` (JSON string)	yes	`"0"` invalid; `"1"` valid

Common request fields and the signature are in Development specification.

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",
 "properties": {
 "audio.dnd.plan": [
 {
 "data": 0,
 "time": "08:30-22:00",
 "status": "0"
 }
 ]
 }
 }
}

# # # Returns a description of the data field

On success, code is "0" and data is {}.

Response example

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

Error Code

Gateway and device error codes are in Global return codes.

Get snooze schedule properties · Snooze