云台镜头控制

接口说明

控制云台镜头的变焦、变倍及光圈大小
命令command=1时，云台会开启动作，不调command=0会一直转动
异步发送操作指令到设备端，需开启动作与停止动作间隔一定时间，保证顺序执行
不推荐多用户同时操作同一个设备，多用户操作以最后一次操作为准

前置条件

请求头设置Authorization字段

前置条件

设备必须是球机

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/admin/API/DMS/Ptz/OperateCamera

请求类型

POST

数据格式

application/json

请求参数

参数名必选类型说明
datatrueObjectJson对象
+channelIdtruestring视频通道编码，第一个$后数字代表通道类型，必须是1，且摄像头类型需是球机(cameraType字段必须是2)
+operateTypetruestring操作类型：1=变倍，2=变焦，3=光圈
+directtruestring方向：1=增加，2=减小
+steptruestring转动速度（1-8的整数） ，越大代表越快
+commandtruestring命令：0=停止动作，1=开启动作；注意事项：停止动作需与开启动作时的其他参数需保持一致，否则无法停止
+extendtruestring扩展数据

请求参数示例

{
  "data": {
    "channelId": "1004325$1$0$0",
    "operateType": "1",
    "direct": "1",
    "step": "1",
    "command": "1",
    "extend": ""
  }
}

返回参数

名称类型说明
codeint错误代码，code=1000代表成功，非1000代表失败，参考附录-错误码
descstring结果描述
dataobject返回数据对象
+resultstring操作结果：0=失败，1=成功，失败时参考LockUser
+lockUserobject锁定用户信息
++userNamestring控制失败时，持有锁的用户名称
++userLevelstring控制失败时，持有锁的用户级别
++lowerDomainint下级域地址，null或者空字符串表示是本级，有地址时表示下级

返回参数示例（成功）

  • 无用户锁定云台
{
  "code": 1000,
  "desc": "Success",
  "data": {
    "result": "1",
    "lockUser": null
  }
}
  • 用户锁定云台
{
  "code": 1000,
  "desc": "Success",
  "data": {
    "result": "0",
    "lockUser": {
      "userName": "system",
      "userLevel": "1",
      "lowerDomain": null
    }
  }
}

返回参数示例（失败）

{
  "code": 1001,
  "desc": "Failed"
}
云台方向控制

接口说明

控制云台进行上下左右等八个方向的移动 命令command=1时，云台会开启动作，不调command=0会一直转动
异步发送操作指令到设备端，需开启动作与停止动作间隔一定时间，保证顺序执行
不推荐多用户同时操作同一个设备，多用户操作以最后一次操作为准

前置条件

请求头设置Authorization字段

前置条件

设备必须是球机

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/admin/API/DMS/Ptz/OperateDirect

请求类型

POST

数据格式

application/json

请求参数

参数名必选类型说明
datatrueObjectJson对象
+channelIdtruestring视频通道编码，第一个$后数字代表通道类型，必须是1，且摄像头类型需是球机(cameraType字段必须是2)
+directtruestring方向：1=上，2=下，3=左，4=右，5=左上，6=左下，7=右上，8=右下
+stepXtruestring水平转动速度（1-8的整数），越大代表越快
+stepYtruestring垂直转动速度（1-8的整数），越大代表越快
+commandtruestring命令：0=停止, 1=开启
+extendtruestring扩展数据

请求参数示例

{
  "data": {
    "channelId": "1004325$1$0$0",
    "direct": "1",
    "stepX": "6",
    "stepY": "6",
    "command": "1",
    "extend": ""
  }
}

返回参数

名称类型说明
codeint错误代码，code=1000代表成功，非1000代表失败，参考附录-错误码
descstring结果描述
dataobject返回数据对象
+resultstring操作结果：0=失败，1=成功，失败时参考LockUser
+lockUserobject锁定用户信息
++userNamestring控制失败时，持有锁的用户名称
++userLevelstring控制失败时，持有锁的用户级别
++lowerDomainint下级域地址，null或者空字符串表示是本级，有地址时表示下级

返回参数示例（成功）

  • 无用户锁定云台
{
  "code": 1000,
  "desc": "Success",
  "data": {
    "result": "1",
    "lockUser": null
  }
}
  • 用户锁定云台
{
  "code": 1000,
  "desc": "Success",
  "data": {
    "result": "0",
    "lockUser": {
      "userName": "system",
      "userLevel": "1",
      "lowerDomain": null
    }
  }
}

返回参数示例（失败）

{
  "code": 1001,
  "desc": "Failed"
}
云台功能控制

接口说明

控制云台的巡航、循迹及灯光等功能 命令command=1时，云台会开启动作，不调command=0会一直转动
异步发送操作指令到设备端，需开启动作与停止动作间隔一定时间，保证顺序执行
不推荐多用户同时操作同一个设备，多用户操作以最后一次操作为准

前置条件

请求头设置Authorization字段

前置条件

设备必须是球机

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/admin/API/DMS/Ptz/OperateFunction

请求类型

POST

数据格式

application/json

请求参数

参数名必选类型说明
datatrueObjectJson对象
+channelIdtruestring视频通道编码，第一个$后数字代表通道类型，必须是1，且摄像头类型需是球机(cameraType字段必须是2)
+operateTypetruestringoperateType操作类型
+targettruestring操作对象：仅当operateType=[14,19,20,21]时有意义，其他情况下为0
+commandtruestring命令：0=停止, 1=开启，仅当operateType=[11,12,13,14,15,18,19,20,21]时有意义，其他情况下为0
+extendtruestring扩展数据

请求参数示例

{
  "data": {
    "channelId": "1018084$1$0$0",
    "operateType": "21",
    "target": "0",
    "command": "1",
    "extend": ""
  }
}

返回参数

名称类型说明
codeint错误代码，code=1000代表成功，非1000代表失败，参考附录-错误码
descstring结果描述
dataobject返回数据对象
+resultstring操作结果：0=失败，1=成功，失败时参考LockUser
+lockUserobject锁定用户信息
++userNamestring控制失败时，持有锁的用户名称
++userLevelstring控制失败时，持有锁的用户级别
++lowerDomainint下级域地址，null或者空字符串表示是本级，有地址时表示下级

返回参数示例（成功）

  • 无用户锁定云台
{
  "code": 1000,
  "desc": "Success",
  "data": {
    "result": "1",
    "lockUser": null
  }
}
  • 用户锁定云台
{
  "code": 1000,
  "desc": "Success",
  "data": {
    "result": "0",
    "lockUser": {
      "userName": "system",
      "userLevel": "10",
      "lowerDomain": null
    }
  }
}

返回参数示例（失败）

{
  "code": 1001,
  "desc": "Failed"
}
获取云台预置点

接口说明

获取云台的预置点信息

前置条件

请求头设置Authorization字段

前置条件

设备必须是球机

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/admin/API/DMS/Ptz/GetPresetPoints

请求类型

POST

数据格式

application/json

请求参数

参数名必选类型说明
datatrueObjectJson对象
+channelIdtruestring视频通道编码，第一个$后数字代表通道类型，必须是1，且摄像头类型需是球机(cameraType字段必须是2)

请求参数示例

{
  "data": {
    "channelId": "1004596$1$0$0"
  }
}

返回参数

名称类型说明
codeint错误代码，code=1000代表成功，非1000代表失败，参考附录-错误码
descstring结果描述
dataobject返回数据对象
+channelIdstring通道编码
+presetPointsarray预置点信息
++idint预置点id
++channelIdstring通道编码
++presetPointCodestring预置点编码
++presetPointNamestring预置点名称

返回参数示例（成功）

{
  "code": 1000,
  "desc": "Success",
  "data": {
    "presetPoints": [
      {
        "id": 1,
        "channelId": "1004596$1$0$0",
        "presetPointCode": "1",
        "presetPointName": "preset1"
      },
      {
        "id": 2,
        "channelId": "1004596$1$0$0",
        "presetPointCode": "2",
        "presetPointName": "2"
      }
    ],
    "channelId": "1004596$1$0$0"
  }
}

返回参数示例（失败）

{
  "code": 1001,
  "desc": "Failed"
}
预置点控制(添加/更新/删除/定位)

接口说明

新增云台预置点、更新云台预置点、删除云台预置点或云台预置点定位

前置条件

设备必须是球机

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/admin/API/DMS/Ptz/OperatePresetPoint

请求类型

POST

数据格式

application/json

请求参数

注意：需要在请求头参数中增加User-Id: 1

参数名必选类型说明
datatrueObjectJson对象
+channelIdtruestring视频通道编码，第一个$后数字代表通道类型，必须是1，且摄像头类型需是球机(cameraType字段必须是2)
+presetPointCodetruestring预置点编码
+presetPointNametruestring预置点名称，更新时只支持更新预置点名称，其他参数不支持更新
+operateTypetruestring操作类型：1=定位，2=添加/更新，3=删除

请求参数示例

{
  "data": {
    "presetPointName":    "point2",
    "presetPointCode":    "2",
    "channelId":    "1004596$1$0$0",
    "operateType":    "1"
  }
}

返回参数

名称类型说明
codeint错误代码，code=1000代表成功，非1000代表失败，参考附录-错误码
descstring结果描述
datastringJson串，默认为空
+resultstring操作结果：0=失败，1=成功，失败时参考LockUser
+lockUserstring锁定用户信息
++userNamestring控制失败时，持有锁的用户名称
++userLevelstring控制失败时，持有锁的用户级别
++lowerDomainint下级域地址，null或者空字符串表示是本级，有地址时表示下级

返回参数示例（成功）

  • 无用户锁定云台
{
  "code": 1000,
  "desc": "Success",
  "data": {
    "result": "1",
    "lockUser": null
  }
}
  • 用户锁定云台
{
  "code": 1000,
  "desc": "Success",
  "data": {
    "result": "0",
    "lockUser": {
      "userName": "system",
      "userLevel": "1",
      "lowerDomain": null
    }
  }
}

返回参数示例（失败）

{
  "code": 1001,
  "desc": "Failed"
}
获取云台巡航线

接口说明

获取云台的巡航线信息

前置条件

请求头设置Authorization字段

前置条件

设备必须是球机

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/admin/API/DMS/Ptz/GetCruises

请求类型

POST

数据格式

application/json

请求参数

参数名必选类型说明
datatrueObjectJson对象
+channelIdtruestring视频通道编码，第一个$后数字代表通道类型，必须是1，且摄像头类型需是球机(cameraType字段必须是2)

请求参数示例

{
  "data": {
    "channelId": "1008005$1$0$0"
  }
}

返回参数

名称类型说明
codeint错误代码，code=1000代表成功，非1000代表失败，参考附录-错误码
descstring结果描述
dataobject返回数据对象
+channelIdstring通道编码
+cruisesarray巡航线信息
++channelIdstring通道编码
++cruiseCodestring巡航线编码
++cruiseNamestring巡航线名称
++pointsarray预置点信息列表
+++codestring预置点编码
+++idint预置点id
+++staystring预置点停留时间

返回参数示例（成功）

{
    "code": "1000",
    "data": {
        "cruises": [
            {
                "pointId": 1,
                "cruiseCode": "1",
                "cruiseName": "cece",
                "channelId": "1000170$1$0$0",
                "points": [
                    {
                        "code": "1",
                        "id": 1,
                        "stay": "15"
                    }
                ]
            },
            {
                "pointId": 3,
                "cruiseCode": "1",
                "cruiseName": "2-3-4",
                "channelId": "1002241$1$0$0",
                "points": [
                    {
                        "code": "2",
                        "id": 1,
                        "stay": "10"
                    },
                    {
                        "code": "3",
                        "id": 2,
                        "stay": "10"
                    },
                    {
                        "code": "4",
                        "id": 3,
                        "stay": "10"
                    }
                ]
            }
        ],
        "channelId": "1002430$1$0$0"
    },
    "desc": "Success"
}

返回参数示例（失败）

{
  "code": 1001,
  "desc": "Failed"
}
保存云台巡航线

接口说明

保存云台巡航线，包含新增与修改，cruiseId与channelId存在则修改，否则新增处理

前置条件

设备必须是球机

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/admin/API/DMS/Cruise/SaveCruise

请求类型

POST

数据格式

application/json

请求参数

参数名必选类型说明
datatrueObjectJson对象
+channelId是string视频通道编码,调设备通道分页查询接口，入参unitTypeList=1获取通道编码channelCode，且摄像头类型需是球机(cameraType字段必须是2)或枪机(cameraType字段必须是1)勾选云台控制能力集
+data是string巡航线XML数据（与下面的jsonData二选一），字符串格式
+jsonData是list巡航线json数据（与上面的data二选一）

jsonData参数说明：

参数名必选类型说明
cruiseCodetruestring巡航线编码
cruiseNametruestring巡航线名称
pointstruelist<Point>预置点列表，元素属性见下表

Point参数说明：

参数名必选类型说明
idtrueint预置点id
codetruestring预置点编码
staytruestring预置点停留时间，范围(15-3600)，默认15秒

data参数说明：

巡航线Cruise属性：

参数名必选类型说明
idtruestring巡航线编码
nametruestring巡航线名称

预置点PrePoint属性：

参数名必选类型说明
idtruestring预置点id
codetruestring预置点编码
staytruestring预置点停留时间，范围(15-3600)，默认15秒

json格式请求参数示例

{
  "data": {
    "channelId": "1000002$1$0$0",
    "data": "",
    "jsonData": [
      {
        "cruiseName": "测试巡航线新增1",
        "cruiseCode": "1",
        "points": [
          {
            "code": "2",
            "id": 1,
            "stay": "15"
          },
          {
            "code": "3",
            "id": 2,
            "stay": "15"
          }
        ]
      },
      {
        "cruiseName": "测试巡航线新增2",
        "cruiseCode": "2",
        "points": [
          {
            "code": "1",
            "id": 1,
            "stay": "15"
          },
          {
            "code": "5",
            "id": 2,
            "stay": "15"
          }
        ]
      }
    ]
  }
}

xml格式请求参数示例

{
  "data": {
    "data": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CruiseConfig>\n\t<Cruise id=\"1\" name=\"测试巡航线新增3\" >\n\t\t<PrePoint id=\"1\" code=\"2\" stay=\"15\" />\n\t\t<PrePoint id=\"2\" code=\"3\" stay=\"15\" />\n\t</Cruise>\n\t<Cruise id=\"2\" name=\"测试巡航线新增4\" >\n\t\t<PrePoint id=\"1\" code=\"1\" stay=\"15\" />\n\t\t<PrePoint id=\"2\" code=\"5\" stay=\"15\" />\n\t</Cruise>\n</CruiseConfig>\n",
    "channelId": "1000002$1$0$0"
  }
}

返回参数

名称类型说明
codestring错误码：1000-为无错误，非1000-为具体错误码
successboolean接口返回是否成功
descstring结果描述

返回参数示例（成功）

{
  "code": 1000,
  "desc": "Success",
  "success": true
}

返回参数示例（失败）

{
  "code": 1001,
  "desc": "Failed",
  "success": false
}
删除云台巡航线

接口说明

删除通道所有的巡航线

前置条件

设备必须是球机

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/admin/API/DMS/Cruise/DeleteCruise

请求类型

POST

数据格式

application/json

请求参数

参数名必选类型说明
datatrueObjectJson对象
- channelIdtruestring视频通道编码，第一个$后数字代表通道类型，必须是1，且摄像头类型需是球机(cameraType字段必须是2)

请求参数示例

{
  "data": {
    "channelId":    "1004596$1$0$0"
  }
}

返回参数

名称类型说明
codeint错误代码，code=1000代表成功，非1000代表失败，参考附录-错误码
descstring结果描述

返回参数示例（成功）

{
  "code": 1000,
  "desc": "Success",
}

返回参数示例（失败）

{
  "code": 1001,
  "desc": "Failed"
}
操作云台巡航线

云台巡航线的 operateType操作类型为14，操作方法接口详见：云台功能控制