detection.siren.start (Start siren)

detection.siren.start: Start siren

detection.siren.start · Channel scope · Permission Config

What it does

Starts the siren on this channel. You may pass clientLocalTime and receive countdown time (seconds). Each call runs once.

Request URL

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

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	`detection.siren.start`
`inputData`	Object	yes	See table below

Name	Type	Required	Description
`clientLocalTime`	`text`	yes	Client local time of day, `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": "detection.siren.start",
 "inputData": {
 "clientLocalTime": "T221000"
 }
 }
}

Response data fields

Output is in result.data.outputData.

Name	Type	Required	Description
`time`	`int`	no	Countdown `0`–`99999`, step `1`, unit s
`clientLocalTime`	`text`	no	`THHmmss`

Response example

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

Error codes

Gateway and device error codes are in Global return codes.

Siren