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

audio.dnd.plan: Read Do Not Disturb schedule

audio.dnd.plan · Device scope · Permission Config

Feature details

Read the device's Do Not Disturb schedule. Up to 5.

Request address

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

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.

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`	Array	yes	`["audio.dnd.plan"]`

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"
 ]
 }
}

# # # Returns a description of the data field

The value is in result.data.properties["audio.dnd.plan"].

Array limit 5.

Name	Description	Type	Required	Values
`properties["audio.dnd.plan"][].data`	Time parameter. Range 0–999999, step 1.	`int`	yes	`0`–`999999`, step `1`
`properties["audio.dnd.plan"][].time`	Time window, format HH:mm-HH:mm, e.g. 08:30-22:00	`text`	yes	Format `HH:mm-HH:mm`
`properties["audio.dnd.plan"][].status`	Task state. 0 invalid, 1 valid.	`enum` (JSON string)	yes	`"0"` invalid; `"1"` valid

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "audio.dnd.plan": [
 {
 "data": 0,
 "time": "08:30-22:00",
 "status": "0"
 }
 ]
 }
 }
 }
}

Error Code

Gateway and device error codes are in Global return codes.

Set snooze schedule properties · Snooze