audio.ring.alarmConfig(device.property.set(设置铃声配置(设备报警)属性))
audio.ring.alarmConfig:device.property.set(设置铃声配置(设备报警)属性)
audio.ring.alarmConfig · 设备级 · 权限 Config
功能详情
设置设备报警铃音配置(ringConfigDevice)。item.relateType 仅 0~6;与 audio.ring.config(ringConfigReply,0~13)不同 property。最多 100 条。越界拒绝,不截断。
请求地址
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set
最小权限
管理员操作自己绑定的设备不需要权限。操作被分享设备需要基础配置权限。子用户绑定不需要。子账号需要 Config。写超时不代表未执行。
传入参数说明
| 参数名 | 参数类型 | 是否必填 | 参数说明 |
|---|---|---|---|
token | String | 是 | 管理员、子用户或子账号 accessToken |
deviceId | String | 是 | 设备序列号 |
productId | String | 否 | 可省略。传了且与该设备实际型号不一致 → DV2009 |
properties | Object | 是 | key 为 audio.ring.alarmConfig |
数组上限 100。每个元素须带齐下表中标为必填的字段。
| 参数名 | 说明 | 类型 | 必填 | 取值 |
|---|---|---|---|---|
item.name | 名称。 | text | 是 | 字符串 |
item.type | 铃声类型。 | enum | 是 | 0 wav;1 pcm;2 aac |
item.index | 铃声索引。范围 0~999999,步长 1。 | int | 是 | 0~999999,步长 1 |
item.state | 铃声状态。0 play,1 download。 | enum | 是 | 0 play;1 download |
item.url | 铃声地址。下载或文件地址。 | text | 是 | 字符串 |
item.ringMode | 区分默认铃声/自定义铃声。0 默认,1 自定义。 | enum | 是 | 0 默认;1 自定义 |
item.ringSet | 是否配置使用该铃声。 | int | 是 | 整数 |
item.relateType | 生效类型。 | enum | 是 | 0 设备报警;1 配件报警;2 自定义回复;3 设备本地铃声,按下门铃后的响声;4 快捷回复;5 门铃关联铃铛的铃声;6 全部类型 |
样例输入
{
"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": [
{
"name": "example",
"type": "0",
"index": 0,
"state": "0",
"url": "example",
"ringMode": "0",
"ringSet": 1,
"relateType": "0"
}
]
}
}
}
返回 data 字段说明
成功时 code 为 "0",data 为 {}。
样例输出
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {}
}
}
错误码
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名校验异常 | 按 HTTP 开发规范 核对 sign |
TK1002 | token 无效或过期 | 重新获取 accessToken |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1009 | 权限不足 | 核对 token 与设备绑定/分享权限 |
OP1013 | 接口总次数超限 | 降低调用频率 |
OP1014 | 接口日限额超限 | 见 接口调用限额 |
DV1007 | 设备离线 | 等设备上线 |
更多见 错误码 · OP/SN/TK。
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV2003 | 设备未声明该属性 | 以 device.capability.list 为准 |
DV2004 | 写入值超出型号范围 | 核对 properties 取值 |
DV2007 | channelId 与 scope 不符 | 通道级必传,设备级不传 |
DV2008 | 同请求混用设备级与通道级 | 拆分请求 |
DV2009 | productId 与型号不一致 | 省略或改为实际型号 |
更多见 能力错误码。
