audio.ring.alarmConfig (Read ringtone configuration (device alarm))

audio.ring.alarmConfig: Read ringtone configuration (device alarm)

audio.ring.alarmConfig · Device scope · Permission Config

Feature details

Read device alarm ringtone configuration (ident ringConfigDevice / property audio.ring.alarmConfig). Up to 100 entries. The property may be absent; when a list is returned, each element must include all fields marked required below. Unlike audio.ring.config (ringConfigReply), which is a different property; item.relateType has a different enumeration scope.

Request address

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

Minimum permission

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.ring.alarmConfig"]`

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.ring.alarmConfig"
 ]
 }
}

# # # Returns a description of the data field

The value is in result.data.properties["audio.ring.alarmConfig"].

Array limit 100. If the property is not reported, the key may be absent from properties.

Name	Description	Type	Required	Values
`item.name`	Name.	`text`	yes	string
`item.type`	Ringtone type.	`enum`	yes	`0` wav; `1` pcm; `2` aac
`item.index`	Ringtone index. Range 0–999999, step 1.	`int`	yes	`0`–`999999`, step `1`
`item.state`	Ringtone state. 0 play, 1 download.	`enum`	yes	`0` play; `1` download
`item.url`	Ringtone URL. Download or file path.	`text`	yes	string
`item.ringMode`	Default vs custom ringtone. 0 default, 1 custom.	`enum`	yes	`0` default; `1` custom
`item.ringSet`	Whether this ringtone is configured for use.	`int`	yes	integer
`item.relateType`	Effective type.	`enum`	yes	`0` device alarm; `1` accessory alarm; `2` custom reply; `3` local device ringtone (doorbell press); `4` quick reply; `5` chime linked to doorbell; `6` all types

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "audio.ring.alarmConfig": [
 {
 "name": "example",
 "type": "0",
 "index": 0,
 "state": "0",
 "url": "example",
 "ringMode": "0",
 "ringSet": 1,
 "relateType": "0"
 }
 ]
 }
 }
 }
}

Error Code

Gateway and device error codes are in Global return codes.

Set ringtone configuration (device alarm) properties · ringtone