接口列表

本节包含设备云台控制相关接口等。

接口列表如下：

序号 接口功能 描述
1 开始云台控制 开始云台转动
2 停止云台控制 停止云台转动
3 镜像翻转 镜像翻转
4 添加预置点 添加预置点
5 调用预置点 调用预置点
6 清除预置点 清除预置点

开始云台控制

  • 接口功能

    对设备进行开始云台控制，开始云台控制之后必须先调用停止云台控制接口才能进行其他操作，包括其他方向的云台转动

  • 请求地址

    https://open.ys7.com/api/lapp/device/ptz/start

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    "Permission":"Ptz" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号，字母需为大写 Y
channelNo int 通道号 Y
direction int 操作命令：0-上，1-下，2-左，3-右，4-左上，5-左下，6-右上，7-右下，8-放大，9-缩小，10-近焦距，11-远焦距 Y
speed int 云台速度：0-慢，1-适中，2-快，海康设备参数不可为0 Y
  • HTTP请求报文
POST /api/lapp/device/ptz/start HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.4g01l53x0w22xbp30ov33q44app1ns9m&deviceSerial=502608888&channelNo=1&direction=2&speed=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况，稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁，稍后再试
20014 deviceSerial不合法
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60000 设备不支持云台控制
60001 用户无云台控制权限
60002 设备云台旋转达到上限位
60003 设备云台旋转达到下限位
60004 设备云台旋转达到左限位
60005 设备云台旋转达到右限位
60006 云台当前操作失败 稍候再试
60009 正在调用预置点
60020 不支持该命令 确认设备是否支持该操作

停止云台控制

  • 接口功能

    设备停止云台控制

  • 请求地址

    https://open.ys7.com/api/lapp/device/ptz/stop

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    "Permission":"Ptz" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号，字母需为大写 Y
channelNo int 通道号 Y
direction int 操作命令：0-上，1-下，2-左，3-右，4-左上，5-左下，6-右上，7-右下，8-放大，9-缩小，10-近焦距，11-远焦距 N

提示：建议停止云台接口带方向参数。

  • HTTP请求报文
POST /api/lapp/device/ptz/stop HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.25ne3gkr6fa7coh34ys0fl1h9hryc2kr&deviceSerial=568261888&channelNo=1&direction=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况，稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁，稍后再试
20014 deviceSerial不合法
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60000 设备不支持云台控制
60001 用户无云台控制权限
60006 云台当前操作失败 稍候再试
60009 正在调用预置点
60020 不支持该命令 确认设备是否支持该操作

镜像翻转

  • 接口功能:

    对设备进行镜像翻转操作(需要设备支持)。

  • 请求地址:

    https://open.ys7.com/api/lapp/device/ptz/mirror

  • 请求方式:

    POST

  • 子账户token请求所需最小权限

    "Permission":"Ptz" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号，字母需为大写 Y
channelNo int 通道号 Y
command int 镜像方向：0-上下, 1-左右, 2-中心 Y
  • HTTP请求报文
POST /api/lapp/device/ptz/mirror HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=427734888&channelNo=1&command=2
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况，稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁，稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60000 设备不支持云台控制
60001 用户无云台控制权限
60006 云台当前操作失败 稍候再试
60009 正在调用预置点
60020 不支持该命令 确认设备是否支持该操作

添加预置点

  • 接口功能

    支持云台控制操作的设备添加预置点

  • 请求地址

    https://open.ys7.com/api/lapp/device/preset/add

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    "Permission":"Ptz" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号，字母需为大写 Y
channelNo int 通道号 Y
  • HTTP请求报文
POST /api/lapp/device/preset/add HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.25ne3gkr6fa7coh34ys0fl1h9hryc2kr&deviceSerial=568261888&channelNo=1
  • 返回数据
{
    "data": {
        "index": 3
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
index int 预置点序号，C6设备是1-12，该参数需要开发者自行保存
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况，稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁，稍后再试
20014 deviceSerial不合法
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60000 设备不支持云台控制
60001 用户无云台控制权限
60006 云台当前操作失败 稍候再试
60007 预置点个数超过最大值
60008 C6预置点个数达到上限，无法添加 C6预置点最大限制个数为12

调用预置点

  • 接口功能

    对预置点进行调用控制

  • 请求地址

    https://open.ys7.com/api/lapp/device/preset/move

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    "Permission":"Ptz" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号，字母需为大写 Y
channelNo int 通道号 Y
index int 预置点，C6设备预置点是1-12 Y
  • HTTP请求报文
POST /api/lapp/device/preset/move HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.25ne3gkr6fa7coh34ys0fl1h9hryc2kr&deviceSerial=568261888&channelNo=1&index=3
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况，稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁，稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60000 设备不支持云台控制
60001 用户无云台控制权限
60006 云台当前操作失败 稍候再试
60009 正在调用预置点
60010 该预置点已经是当前位置
60011 预置点不存在
60020 不支持该命令 确认设备是否支持该操作

清除预置点

  • 接口功能

    清除预置点

  • 请求地址

    https://open.ys7.com/api/lapp/device/preset/clear

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    "Permission":"Ptz" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号，字母需为大写 Y
channelNo int 通道号 Y
index int 预置点，C6设备预置点是1-12 Y
  • HTTP请求报文
POST /api/lapp/device/preset/clear HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.25ne3gkr6fa7coh34ys0fl1h9hryc2kr&deviceSerial=568261888&channelNo=1&index=3
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况，稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁，稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60000 设备不支持云台控制
60001 用户无云台控制权限
60006 云台当前操作失败 稍候再试
60020 不支持该命令 确认设备是否支持该操作

results matching ""

    No results matching ""