开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
      • 通用方法
      • 侦测与告警
      • 图像
      • 云台
        • 云台移动
        • 巡航
        • 枪球联动
        • 预置点
          • ptz.preset.stayTime(获取收藏点停留时间属性)
          • ptz.preset.stayTime(设置收藏点停留时间属性)
          • ptz.preset.idle(获取守望属性)
          • ptz.preset.idle(设置守望属性)
          • ptz.preset.idleDelay(获取收藏点空闲动作检测延时时间属性)
          • ptz.preset.idleDelay(设置收藏点空闲动作检测延时时间属性)
          • ptz.preset.return(获取回归收藏点信息属性)
          • ptz.preset.return(设置回归收藏点信息属性)
          • ptz.preset.add(添加收藏点)
          • ptz.preset.delete(删除收藏点)
          • ptz.preset.goto(转到收藏点)
          • ptz.preset.list(获取收藏点)
          • ptz.preset.rename(重命名收藏点)
          • ptz.preset.set(设置收藏点)
        • 变焦
      • 灯光
      • 录像
      • 音频
      • 媒体
      • 网络
      • 电源
      • 隐私
      • 呼叫
      • 存储
      • 系统
      • 算法
      • 设备维护
      • 控制
    • 事件总览
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

ptz.preset.rename(重命名收藏点)

ptz.preset.rename:重命名收藏点

ptz.preset.rename · 通道级 · 权限 Config

功能详情

CollectionPoint 分路常用 name;Preset 分路常用 index(与 list 出参对齐)。以 device.capability.list 为准。 调用前设备须具备 CollectionPoint 和/或 Preset 能力(见 预置点概览),以 device.capability.list 为准。

重命名收藏点;oldName 须与 list 一致。调一次执行一次。

请求地址

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

最小权限

管理员操作自己绑定的设备不需要权限。操作被分享设备需要基础配置权限。子用户绑定不需要。子账号需要 Config。通道级漏 channelId 返回 DV2007。设备和通道写在同一次请求里返回 DV2008。超时不代表未执行。

传入参数说明

参数名参数类型是否必填参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString是设备序列号
productIdString否可省略。传了且与该设备实际型号不一致 → DV2009
channelIdString是通道号,IPC 常见 "0"
serviceIdString是ptz.preset.rename
inputDataObject是见下表
参数名说明类型必填取值
oldName老收藏点。text是字符串
newName新名称。text是字符串

公共请求字段与签名见 签名约定 与 公共请求负载。

样例输入

{
 "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": "ptz.preset.rename",
 "inputData": {
 "oldName": "point1",
 "newName": "gate"
 }
 }
}

返回 data 字段说明

出参在 result.data.outputData。无出参为 {}。

样例输出

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

错误码

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

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

错误码错误码说明下一步
DV2003设备未声明该能力以 device.capability.list 为准
DV2007channelId 与 scope 不符通道级必传,设备级不传
DV2008同请求混用设备级与通道级拆分请求
DV2009productId 与型号不一致省略或改为实际型号
DV2011无能力权限见 权限码

更多见 能力错误码。

预置点

ptz.preset.list(获取收藏点)
ptz.preset.set(设置收藏点)