Set a Custom Alarm Sound when Human Detection or Motion Detection is enabled on the device
Production: https://open.eye4cloud.com/{{open_id}}/open/v1/device/customAlarmSound| Field Name | Required | Type | Description |
|---|---|---|---|
| device_id | Yes | string | Device ID |
| timestamp | Yes | int64 | Timestamp in seconds |
| nonce | Yes | string | Random string, 8-20 characters |
| sign | Yes | string | See "Sign Generation Examples" for the implementation details |
| password | No | string | Device password; if omitted, the password registered for the device on the Open Platform is used |
| data | No | string | Device DATA; an empty string can be passed |
| imei | No | string | Device IMEI; an empty string can be passed |
| voiceType | Yes | int | Custom prompt sound type (pass the value according to the motion detection type; it has no effect if the types do not match): 1=Human Detection, 3=Motion Detection |
| switch | Yes | int | Custom prompt sound switch: 0=off, 1=on |
| PlayTimes | Yes | int | Number of plays |
| urlJson | Yes | string | Download URL |
| filename | Yes | string | File Name |
| play | Yes | int | Preview: 0=do not play, 1=play |
curl 'https://open.eye4cloud.com/{{open_id}}/open/v1/device/customAlarmSound' \
-H 'Content-Type: application/json' \
--data-raw '{
"device_id": "xxxx",
"timestamp": 1758867195,
"nonce": "",
"sign": "",
"password": "",
"voiceType":1,
"switch":1,
"PlayTimes":1,
"urlJson":"{"url":"https://example.com/DEMO_RESOURCE"}",
"filename":"您已进入监控区域",
"play":1
}'
| Field Name | Type | Description |
|---|---|---|
| error_code | int | Status code: 0 indicates success; other values indicate an error |
| error_message | string | Error message; success indicates a normal response |
| data | object | {} |
| data.resp | int | Response: 1 means execution succeeded; 2 means execution failed |
Example:
{
"error_code": 0,
"error_message": "success",
"error_tips": "",
"data": {
"resp": 1
}
}