light.white.start (Start countdown white light)

light.white.start: Start countdown white light

light.white.start · Channel scope · Permission Config

What it does

Instant on for a countdown white-light session; configuration switch: enabled. Returned time usually comes from default countdown duration. Poll state while running. Input clientLocalTime. One invoke runs one action.

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. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008. A timeout does not mean the operation did not run.

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`
`channelId`	String	yes	Channel ID; `"0"` is common on IPCs
`serviceId`	String	yes	`light.white.start`
`inputData`	Object	yes	See section below

`inputData` fields

Name	Description	Type	Required	Values
`clientLocalTime`	Client local time within the day. Format THHmmss, e.g. T000000.	`text`	yes	Format `THHmmss`, e.g. `T000000`

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",
 "channelId": "0",
 "serviceId": "light.white.start",
 "inputData": {
 "clientLocalTime": "T221000"
 }
 }
}

Response data fields

Output is in result.data.outputData.

Name	Description	Type	Required	Values
`clientLocalTime`	Client local time within the day. Format THHmmss, e.g. T000000.	`text`	no	Format `THHmmss`, e.g. `T000000`
`time`	Countdown. Range -1–9999, step 1, unit s.	`int`	no	`-1`–`9999`, step `1`, unit `s`

Response example

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

Error codes

Gateway and device error codes are in Global return codes.

White light