接口功能 本接口主要提供httpAPI接口向接入的视频设备下达云台控制指令。控制摄像头设备进行上、下、左、右、左上、左下、右上、右下等八方位方向的移动;控制云台镜头的变倍、聚焦和光圈大小功能(说明:此接口功能只对支持云台控制的终端设备有效,例如海康、大华的球机)。
Request URL: http://192.168.0.105:18080/api/ptz/control/
域名访问URL: http://iotbox.iotrelay.cn:8080/api/api/ptz/control/
Request Method: POST
数据提交格式 form-data
请求头参数 Authorization
请求头参数说明:
参数名 | 类型 | 必须 | 描述 |
---|---|---|---|
Authorization | Header | 是 | 固定值:字符串“Bearer” +“token”组成, "token"为上述登录接口获取的属性值,如:请求头中 “Authorization” : “Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiNjE3OGVlN2ZhNWM0OWU2ODlmMGEzNjIxNzkxYzk2OCIsInN1YiI6IntcInVzZXJJZFwiOlwiNDlcIixcInVzZXJOYW1lXCI6XCIxMzQzNzE1NjU2OVwiLFwibmlja05hbWVcIjpcIjQ0MDgwMDAwMDAxMTExMDAwMDE3XCJ9IiwiaXNzIjoic2oiLCJpYXQiOjE2OTcxNTk2NjgsImV4cCI6MTY5NzE2MTQ2OH0.4C3GJIF5ejmySHy9l_LmheoCs5jknq17h9tPsZB3dIM” |
请求体格式 form-data
请求体参数说明:
参数名 | 类型 | 必须 | 描述 |
---|---|---|---|
deviceId | string | 是 | 接入视频设备ID标识,对应位置在 视频设备–我的接入配置–监控设备接入配置信息–SIP用户认证ID 如:黄色 "44080000001111000001"为接入视频设备SIP用户认证ID值 |
channelId | string | 是 | IOT接入视频设备视频监控通道编号ID,对应位置在 视频设备–我的接入配置–监控设备接入配置信息–视频监控通道编号ID 如:黄色 “44090000001321000002” |
command | string | 是 | IOT接入视频设备(摄像头)控制指令,允许值: left, right, up, down, upleft, upright, downleft, downright, zoomin, zoomout, stop |
horizonSpeed | integer | 否 | 摄像头控制指令,摄像头水平移动速度,数值不要太大,尽量小于50 |
verticalSpeed | integer | 否 | 摄像头控制指令,摄像头水平垂直速度,数值不要太大,尽量小于50 |
zoomSpeed | integer | 否 | 摄像头控制指令,摄像头水平缩放速度,数值不要太大,尽量小于50 |
正确响应结果示例:
{ "code": "0", "msg": "success", "data": "true", }
错误响应结果示例:
{ "code": "-1", "msg": "fail:发送指令执行失败" }
接口功能 本接口主要提供httpAPI接口向接入的视频设备下达云台控制指令,包括PTZ指令、FI指令、巡航指令、扫描指令和辅助开关指令。
Request URL: http://192.168.0.105:18080/api/ptz/front_end_command/
域名访问URL: http://iotbox.iotrelay.cn:8080/api/api/ptz/front_end_command/
Request Method: POST
数据提交格式 form-data
请求头参数 Authorization
请求头参数说明:
参数名 | 类型 | 必须 | 描述 |
---|---|---|---|
Authorization | Header | 是 | 固定值:字符串“Bearer” +“token”组成, "token"为上述登录接口获取的属性值,如:请求头中 “Authorization” : “Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiNjE3OGVlN2ZhNWM0OWU2ODlmMGEzNjIxNzkxYzk2OCIsInN1YiI6IntcInVzZXJJZFwiOlwiNDlcIixcInVzZXJOYW1lXCI6XCIxMzQzNzE1NjU2OVwiLFwibmlja05hbWVcIjpcIjQ0MDgwMDAwMDAxMTExMDAwMDE3XCJ9IiwiaXNzIjoic2oiLCJpYXQiOjE2OTcxNTk2NjgsImV4cCI6MTY5NzE2MTQ2OH0.4C3GJIF5ejmySHy9l_LmheoCs5jknq17h9tPsZB3dIM” |
请求体格式 form-data
请求体参数说明:
参数名 | 类型 | 必须 | 描述 |
---|---|---|---|
deviceId | string | 是 | 接入视频设备ID标识,对应位置在 视频设备–我的接入配置–监控设备接入配置信息–SIP用户认证ID 如:黄色 "44080000001111000001"为接入视频设备SIP用户认证ID值 |
channelId | string | 是 | IOT接入视频设备视频监控通道编号ID,对应位置在 视频设备–我的接入配置–监控设备接入配置信息–视频监控通道编号ID 如:黄色 “44090000001321000002” |
cmdCode | string | 是 | IOT接入视频设备(摄像头)控制指令指令码 |
parameter1 | integer | 否 | 数据一 |
parameter2 | integer | 否 | 数据二 |
combindCode2 | integer | 组合码二 | 摄像头控制指令,摄像头水平缩放速度,数值不要太大,尽量小于50 |
正确响应结果示例:
{ "code": "0", "msg": "success", "data": "true" }
错误响应结果示例:
{ "code": "-1", "msg": "fail:发送指令执行失败" }
接口功能 本接口主要提供httpAPI接口向支持云台控制的接入的视频设备下达云台控制指令,查询当前摄像头的预置位。
Request URL: http://192.168.0.105:18080/api/ptz/preset/query
域名访问URL: http://iotbox.iotrelay.cn:8080/api/api/ptz/preset/query
Request Method: GET
数据提交格式 Query String Parameters
请求头参数 Authorization
请求头参数说明:
参数名 | 类型 | 必须 | 描述 |
---|---|---|---|
Authorization | Header | 是 | 固定值:字符串“Bearer” +“token”组成, "token"为上述登录接口获取的属性值,如:请求头中 “Authorization” : “Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiNjE3OGVlN2ZhNWM0OWU2ODlmMGEzNjIxNzkxYzk2OCIsInN1YiI6IntcInVzZXJJZFwiOlwiNDlcIixcInVzZXJOYW1lXCI6XCIxMzQzNzE1NjU2OVwiLFwibmlja05hbWVcIjpcIjQ0MDgwMDAwMDAxMTExMDAwMDE3XCJ9IiwiaXNzIjoic2oiLCJpYXQiOjE2OTcxNTk2NjgsImV4cCI6MTY5NzE2MTQ2OH0.4C3GJIF5ejmySHy9l_LmheoCs5jknq17h9tPsZB3dIM” |
请求体参数说明:
参数名 | 类型 | 必须 | 描述 |
---|---|---|---|
deviceId | string | 是 | 接入视频设备ID标识,对应位置在 视频设备–我的接入配置–监控设备接入配置信息–SIP用户认证ID 如:黄色 "44080000001111000001"为接入视频设备SIP用户认证ID值 |
channelId | string | 是 | IOT接入视频设备视频监控通道编号ID,对应位置在 视频设备–我的接入配置–监控设备接入配置信息–视频监控通道编号ID 如:黄色 “44090000001321000002” |
正确响应结果示例:
{ "code": "0", "msg": "success", "data": "true", }
错误响应结果示例:
{ "code": "-1", "msg": "fail:数据查询失败" }