开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
      • 通用方法
      • 侦测与告警
      • 图像
      • 云台
      • 灯光
      • 录像
      • 音频
        • 免打扰
        • 麦克风采集
        • 提示音
        • 铃声
          • audio.ring.config(获取铃声配置属性)
          • audio.ring.config(设置铃声配置属性)
          • audio.ring.alarmConfig(device.property.get(获取铃声配置(设备报警)属性))
          • audio.ring.alarmConfig(device.property.set(设置铃声配置(设备报警)属性))
          • audio.ring.alarmBell(获取设备报警铃声属性)
          • audio.ring.alarmBell(设置设备报警铃声属性)
          • audio.ring.maxCount(获取铃声数量属性)
          • audio.ring.add(新增铃声)
          • audio.ring.delete(删除铃声)
          • audio.ring.updateList(全量更新自定义铃声列表)
        • 报警语音
        • 语音控制
        • 音量
      • 媒体
      • 网络
      • 电源
      • 隐私
      • 呼叫
      • 存储
      • 系统
      • 算法
      • 设备维护
      • 控制
    • 事件总览
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

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。写超时不代表未执行。

传入参数说明

参数名参数类型是否必填参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString是设备序列号
productIdString否可省略。传了且与该设备实际型号不一致 → DV2009
propertiesObject是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
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

错误码错误码说明下一步
DV2003设备未声明该属性以 device.capability.list 为准
DV2004写入值超出型号范围核对 properties 取值
DV2007channelId 与 scope 不符通道级必传,设备级不传
DV2008同请求混用设备级与通道级拆分请求
DV2009productId 与型号不一致省略或改为实际型号

更多见 能力错误码。

获取铃声配置(设备报警)属性 · 铃声

audio.ring.alarmConfig(device.property.get(获取铃声配置(设备报警)属性))
audio.ring.alarmBell(获取设备报警铃声属性)