开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
      • 门锁(遗留)
      • 告警消息(遗留)
      • 设备查询(已弃用)
      • 设备维护(遗留)
      • 设备操作(遗留)
        • calibrationDeviceTime(校准设备 UTC 时间)
        • controlLocationPTZ(云台定位)
        • controlMovePTZ(云台移动控制)
        • controlPTZ(云台控制)
        • devicePTZInfo(查询云台位置)
        • getDeviceTime(查询设备 UTC 时间)
        • restartDevice(重启设备)
      • 设备使能(遗留)
      • 动检配置(遗留)
      • 收藏点(遗留)
      • 定时巡航(遗留)
      • 本地录像配置(遗留)
      • 音量(遗留)
      • 存储(遗留)
      • 图像与视频(遗留)
      • 时区(遗留)
      • Wi-Fi(遗留)
      • 本地录像查询(遗留)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
请求格式
功能说明
请求地址
请求参数
请求示例
返回 data 字段
响应示例
错误码
说明
说明
相关
相关参考

controlPTZ(云台控制)

controlPTZ:云台控制

请求格式

POST JSON 请求体见 请求约定;签名见 签名。

Z

遗留 HTTP 保留: 新接入可使用 云台相对移动(device.service.invoke)对应能力。两套接口不是一对一替代。 registry 没有为本旧方法登记一对一映射。

功能说明

控制设备云台移动、定位、变倍。

请求地址

https://openapi-[DataCenter].easy4ip.com/openapi/controlPTZ

请求参数

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员accessToken
deviceIdString是设备序列号
channelIdString是通道号
operationString是"move"、"locate"操作类型"move":移动操作 "locate":定位操作
hDouble是operation=move时,取[-8,8];operation=locate时,取[-1,1]水平操作参数
vDouble是operation=move时,取[-8,8];operation=locate时,取[-1,1]垂直操作参数
zDouble是move:开放网关对非零售云 appId 常强制为 0(变倍不生效);locate:取 [0,1]变倍参数
durationString否"last"或者毫秒值operation="move"时有意义:表示移动持续时间,单位毫秒,没有operation字段或operation字段填“last”表示一直运动下去。

注意:TP1设备不支持负角度,故设备型号为TP1时,v不可为负数

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599027466,
 "nonce":"44299852-e827-46c0-8feb-f373dde79083"
 },
 "id":"21893dda-17b6-418d-9178-e05f31ae79ec",
 "params":{
 "duration":"2000",
 "v":"4",
 "h":"4",
 "z":"0",
 "deviceId":"TESTQWERXXXX",
 "operation":"move",
 "channelId":"0",
 "token": "<yourAccessToken>"
 }
}

operation取值为"move"或者"locate",两种操作不能同时进行。

当operation为move时,表示移动: H 水平移动速度:范围[-8,8],负数向左,正数向右。 V 垂直移动速度:范围[-8,8],负数向下,正数向上。 Z 变倍:开放网关 move 时对多数 appId 忽略入参并置 0;零售云等例外以实现为准。立即停止常用 0,0,1(Z 在 move 下仍可能被置 0)。 注意:三个参数为 0,0,1 时表示立即停止。 duration表示移动的持续时间,单位毫秒。没有duration字段或duration字段填“last”表示一直运动下去。

当operation为locate时,表示定位: H 水平位置:取值范围-1~1 V 垂直位置:取值范围-1~1 Z 变倍倍数:归一化0~1,其中0是缩到最小,1表示放到最大。 duration参数无意义,可省略duration字段。

返回 data 字段

无data数据返回

响应示例

{
	"id":"21893dda-17b6-418d-9178-e05f31ae79ec",
	"result":{
		"code":"0",
		"msg":"操作成功"
	}
}

错误码

本接口可能返回下列码;完整分组见 错误码 与 能力错误码。

说明

支持管理员或子账号 accessToken。子账号须在策略中授予对应设备/通道权限,配置见 权限码。 本接口属于旧版协议,无替代。

网关与鉴权(SN / TK / OP)

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

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

子账号(SUB)

错误码错误码说明下一步
SUB1001–SUB1002子账号无接口权限在 addPolicy 中补策略
SUB1005子账号 token 过期重新 subAccountToken
SUB1006子账号与设备无授权核对 Resource 与设备序列号
SUB1008子账号未绑定应用先创建并绑定子账号

更多见 错误码 · SUB。

设备访问与通道(DV10xx)

错误码错误码说明下一步
DV1007设备离线或超时等设备上线
DV1009设备正忙稍后重试
DV1012分享/授权设备权限不足核对子账号 Permission / Resource
DV1019能力集不支持确认型号与能力列表
DV1020通道离线检查通道状态
DV1026不支持此功能换接口或升级固件
DV1028未绑定或通道不存在核对 deviceId / channelId

更多见 错误码 · DV。

收藏点与云台(DV10xx)

错误码错误码说明下一步
DV1022收藏点数量超限先删除再添加
:---:---:---
DV1023收藏点已存在改名或跳过
:---:---:---
DV1024收藏点不存在核对收藏点 id

说明

支持管理员或子账号 accessToken。子账号须在策略中授予对应设备/通道权限,配置见 权限码。

本接口属于旧版协议,无替代。

相关

  • 旧版协议目录

相关参考

  • 开发规范
  • 公共约定
  • 本模块索引
controlMovePTZ(云台移动控制)
devicePTZInfo(查询云台位置)