ms-vite-plugin 1.1.20 → 1.1.21

package/docs/httpapi/api.md

@@ -0,0 +1,2411 @@
+---
+title: 默认模块
+language_tabs:
+  - shell: Shell
+  - http: HTTP
+  - javascript: JavaScript
+  - ruby: Ruby
+  - python: Python
+  - php: PHP
+  - java: Java
+  - go: Go
+toc_footers: []
+includes: []
+search: true
+code_clipboard: true
+highlight_theme: darkula
+headingLevel: 2
+generator: "@tarslib/widdershins v4.0.30"
+
+---
+
+# 默认模块
+
+Base URLs:
+
+# Authentication
+
+# Api
+
+## POST 同步脚本
+
+POST /api/sync
+
+> Body 请求参数
+
+```yaml
+string
+
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|projectName|query|string| 否 |项目名称|
+|body|body|string(binary)| 否 |none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 运行UI
+
+GET /api/runUI
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "message": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» message|string|true|none|提示信息|none|
+
+## GET 运行脚本
+
+GET /api/run
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "message": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none||none|
+|» message|string|true|none||none|
+
+## GET 停止脚本
+
+GET /api/stop
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "message": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none||none|
+|» message|string|true|none||none|
+
+## GET 节点XML（仅Agent)
+
+GET /api/source
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|max_depth|query|integer| 是 |页面深度|
+|timeout|query|integer| 是 |超时时间（单位秒）|
+
+> 返回示例
+
+> 200 Response
+
+```xml
+<?xml version="1.0" encoding="UTF-8" ?>
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 截图
+
+GET /api/screenshot
+
+> 返回示例
+
+> 200 Response
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 截图Base64
+
+GET /api/screenshotBase64
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "data": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» data|string|true|none|base64 截图|none|
+
+## GET 获取已安装的应用列表
+
+GET /api/apps
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "data": [
+    {
+      "appName": "string",
+      "bundleIdentifier": "string",
+      "bundleVersion": "string"
+    }
+  ],
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» data|[object]|true|none|应用列表|none|
+|»» appName|string|true|none|应用名称|none|
+|»» bundleIdentifier|string|true|none|应用bundleId|none|
+|»» bundleVersion|string|true|none|应用版本|none|
+|» success|boolean|true|none||none|
+
+## GET 获取当前在前台的APP（仅Agent)
+
+GET /api/activeAppInfo
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "data": {
+    "name": "string",
+    "bundleId": "string",
+    "pid": 0
+  }
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none||none|
+|» data|object|true|none||none|
+|»» name|string|true|none||none|
+|»» bundleId|string|true|none|应用包名|none|
+|»» pid|integer|true|none||none|
+
+## POST 登录接口
+
+POST /api/login
+
+> Body 请求参数
+
+```json
+{
+  "serverType": "domestic",
+  "username": "string",
+  "password": "string"
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|body|body|object| 是 ||none|
+|» serverType|body|string| 是 | 服务器类型|none|
+|» username|body|string| 是 | 用户名|none|
+|» password|body|string| 是 | 密码|none|
+
+#### 枚举值
+
+|属性|值|
+|---|---|
+|» serverType|domestic|
+|» serverType|international|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "message": "string",
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» message|string|true|none|提示信息|none|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 登出接口
+
+GET /api/logout
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "message": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» message|string|true|none|信息|none|
+
+## GET 获取软件状态
+
+GET /api/status
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "data": {
+    "deviceIp": "string",
+    "screenInfo": {
+      "logicWidth": 0,
+      "logicHeight": 0,
+      "height": 0,
+      "width": 0,
+      "scale": 0
+    },
+    "deviceName": "string",
+    "batteryInfo": {
+      "level": 0,
+      "isCharging": true
+    },
+    "appName": "string",
+    "appBuildNumber": 0,
+    "appBundleId": "string",
+    "deviceModel": "string",
+    "agentConnected": true,
+    "isRun": true,
+    "isDebugMode": true,
+    "isAuth": true,
+    "isRecording": true,
+    "udid": "string",
+    "serverDeviceId": "string",
+    "isPipScriptControlEnabled": true,
+    "orientation": "PORTRAIT",
+    "osVersion": "string",
+    "ecid": "string",
+    "isVolumeControlEnabled": true,
+    "agentVersion": "string",
+    "appVersion": "string",
+    "serverType": "international",
+    "isHidConnected": true,
+    "isShowUI": true,
+    "isLogin": true,
+    "isPipWindowEnabled": true,
+    "deviceId": "string"
+  }
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» data|[软件状态](#schema软件状态)|true|none||none|
+|»» deviceIp|string|true|none|设备IP|none|
+|»» screenInfo|object|true|none|屏幕信息|none|
+|»»» logicWidth|integer|true|none|逻辑宽带|none|
+|»»» logicHeight|integer|true|none|逻辑高度|none|
+|»»» height|integer|true|none|物理高度|none|
+|»»» width|integer|true|none|物理宽度|none|
+|»»» scale|number|true|none|缩放比|none|
+|»» deviceName|string|true|none|设备名称|none|
+|»» batteryInfo|object|true|none|电池信息|none|
+|»»» level|integer|true|none|电量 1-100|none|
+|»»» isCharging|boolean|true|none|是否充电中|none|
+|»» appName|string|true|none|app名称|none|
+|»» appBuildNumber|integer|true|none|app构建号|none|
+|»» appBundleId|string|true|none|app 包名|none|
+|»» deviceModel|string|true|none|设备型号|none|
+|»» agentConnected|boolean|true|none|agent是否连接|none|
+|»» isRun|boolean|true|none|脚本是否启动|none|
+|»» isDebugMode|boolean|true|none|是否调试模式运行|none|
+|»» isAuth|boolean|true|none|是否授权|none|
+|»» isRecording|boolean|true|none|是否录屏中|none|
+|»» udid|string|true|none|设备唯一 UDID|none|
+|»» serverDeviceId|string|true|none|服务器设备ID|none|
+|»» isPipScriptControlEnabled|boolean|true|none|悬浮窗控制是否打开|none|
+|»» orientation|string|true|none|屏幕方向|none|
+|»» osVersion|string|true|none|系统版本|none|
+|»» ecid|string|true|none|设备唯一 ECID|none|
+|»» isVolumeControlEnabled|boolean|true|none|是否开启了音量键启停|none|
+|»» agentVersion|string|true|none|agent版本号|none|
+|»» appVersion|string|true|none|app版本号|none|
+|»» serverType|string|true|none|授权服务器类型|none|
+|»» isHidConnected|boolean|true|none|hid设备是否连接|none|
+|»» isShowUI|boolean|true|none|实现显示了 UI|none|
+|»» isLogin|boolean|true|none|是否登录|none|
+|»» isPipWindowEnabled|boolean|true|none|悬浮窗是否打开|none|
+|»» deviceId|string|true|none|设备 ID，应用唯一，卸载重装变化|none|
+
+#### 枚举值
+
+|属性|值|
+|---|---|
+|orientation|PORTRAIT|
+|orientation|LANDSCAPE|
+|serverType|international|
+|serverType|domestic|
+
+## GET App切到前台
+
+GET /api/takeMeToFront
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 获取所有配置
+
+GET /api/getAllConfig
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "data": {}
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» data|object|true|none||none|
+
+## POST 设置所有配置
+
+POST /api/setAllConfig
+
+> Body 请求参数
+
+```json
+{}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|body|body|object| 否 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## POST 设置配置项
+
+POST /api/setConfig
+
+> Body 请求参数
+
+```json
+{
+  "key": "string",
+  "value": "string"
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|body|body|object| 否 ||none|
+|» key|body|string| 是 | 配置 Key|none|
+|» value|body|string| 是 | 配置 Value|none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 实时屏幕画面流MJPEG
+
+GET /mirror/image
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|fps|query|integer| 是 ||帧率|
+|quality|query|number| 是 ||质量 0.1-1.0|
+
+> 返回示例
+
+> 200 Response
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## POST 执行脚本（仅支持JS脚本）
+
+POST /api/runScript
+
+脚本如果最后一行如果有返回值，会转成 json 返回，不需要写 return
+
+如 
+appleOcr.recognize('screen');
+或者
+let a = 1;
+a;
+
+> Body 请求参数
+
+```json
+{
+    "script": "appleOcr.recognize('screen');"
+}
+```
+
+```json
+{
+    "script": "let a = 1; \n a;"
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|body|body|object| 否 ||none|
+|» script|body|string| 是 | 脚本文本|none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 加载指定软件包
+
+GET /api/load
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|appNo|query|string| 否 ||软件编号|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "message": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» message|string|true|none|信息|none|
+
+# Api/日志接口
+
+## GET 日志列表
+
+GET /logger/files
+
+> 返回示例
+
+> 200 Response
+
+```json
+[
+  {
+    "filePath": "string",
+    "fileName": "string",
+    "modificationDate": "string",
+    "fileSize": "string"
+  }
+]
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» filePath|string|true|none|文件路径|none|
+|» fileName|string|true|none|文件名|none|
+|» modificationDate|string|true|none|最后更新时间|none|
+|» fileSize|string|true|none|文件大小|none|
+
+## GET 下载日志
+
+GET /logger/download
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|fileName|query|string| 否 ||none|
+
+> 返回示例
+
+> 200 Response
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+# Api/输入法接口
+
+## GET API键盘是否弹出
+
+GET /api/ime/isOk
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅API键盘弹出可用)输入文字
+
+GET /api/ime/input
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|text|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅API键盘弹出可用)获取已输入文本
+
+GET /api/ime/getText
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "data": "string",
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» data|string|true|none|已输入文本|none|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅API键盘弹出可用)清空文本
+
+GET /api/ime/clearText
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅API键盘弹出可用)粘贴文本
+
+GET /api/ime/paste
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|text|query|string| 否 ||为空时使用剪切板数据，不为空输入指定数据|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "data": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» data|string|true|none|成功返回输入的数据|none|
+
+## GET (仅API键盘弹出可用)按删除键
+
+GET /api/ime/pressDel
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "data": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» data|string|true|none|剩余文本数据|none|
+
+## GET (仅API键盘弹出可用)按回车键
+
+GET /api/ime/pressEnter
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅API键盘弹出可用)隐藏键盘
+
+GET /api/ime/dismiss
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅API键盘弹出可用)获取剪切板
+
+GET /api/ime/getClipboard
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "data": "string",
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» data|string|true|none|剪切板内容|none|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅API键盘弹出可用)设置剪切板
+
+GET /api/ime/setClipboard
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|text|query|string| 否 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+# Api/Agent控制接口（仅Agent）
+
+## GET 返回主页
+
+GET /api/control/home
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET App切换器
+
+GET /api/control/recent
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 点击操作
+
+GET /api/control/click
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|x|query|string| 是 ||点击坐标X|
+|y|query|string| 是 ||点击坐标Y|
+|duration|query|string| 是 ||持续时间|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 双击操作
+
+GET /api/control/doubleClick
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|x|query|integer| 是 ||点击坐标X|
+|y|query|integer| 是 ||点击坐标Y|
+|duration|query|integer| 是 ||持续时间|
+|interval|query|integer| 否 ||间隔时间|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 滑动操作
+
+GET /api/control/swipe
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|startX|query|integer| 是 ||起点X|
+|startY|query|integer| 是 ||起点Y|
+|endX|query|integer| 是 ||终点X|
+|endY|query|integer| 是 ||终点Y|
+|duration|query|integer| 是 ||持续时间（毫秒）|
+|jitter|query|boolean| 否 ||是否开启抖动|
+|steps|query|integer| 否 ||抖动步数|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 按按钮
+
+GET /api/control/pressButton
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|button|query|string| 是 ||按钮|
+
+#### 枚举值
+
+|属性|值|
+|---|---|
+|button|home|
+|button|volumeup|
+|button|volumedown|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅键盘弹出可用)输入文字
+
+GET /api/control/input
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|text|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅键盘弹出可用)退格
+
+GET /api/control/backspace
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|count|query|integer| 是 ||删除数量|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅键盘弹出可用)回车
+
+GET /api/control/enter
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 打开App
+
+GET /api/control/startApp
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|bundleId|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 激活App（把App拉到前台）
+
+GET /api/control/activateApp
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|bundleId|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 停止App
+
+GET /api/control/stopApp
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|bundleId|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 打开URL
+
+GET /api/control/openURL
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|url|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## POST W3CActions
+
+POST /api/control/w3cActions
+
+> Body 请求参数
+
+```json
+{
+  "actions": [
+    "string"
+  ]
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|body|body|object| 是 ||none|
+|» actions|body|[string]| 是 | W3C 动作|none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+# Api/HID控制接口（仅HID）
+
+## GET (仅键盘弹出可用)输入文字
+
+GET /api/hid/input
+
+输入文字，相当于复制粘贴，有 API 键盘的情况下使用 API 键盘输入
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|text|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅键盘弹出可用)输入字符
+
+GET /api/hid/inputSimple
+
+输入字符，相当于按键盘，只能输入键盘的按键，不能输入中文
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|text|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅键盘弹出可用)退格
+
+GET /api/hid/backspace
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|count|query|integer| 是 ||删除数量|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET (仅键盘弹出可用)回车
+
+GET /api/hid/enter
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 按按钮
+
+GET /api/hid/pressButton
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|button|query|string| 是 ||按钮|
+
+#### 枚举值
+
+|属性|值|
+|---|---|
+|button|home|
+|button|volumeup|
+|button|volumedown|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 快捷指令截图
+
+GET /api/hid/shortcutScreenshot
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 快捷指令截图Base64
+
+GET /api/hid/shortcutScreenshotBase64
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 打开录屏界面
+
+GET /api/hid/openRecordScreen
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 获取录屏状态
+
+GET /api/hid/isRecording
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true,
+  "data": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+|» data|boolean|true|none|录屏是否运行中|none|
+
+## GET 返回主页
+
+GET /api/hid/home
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET App切换器
+
+GET /api/hid/recent
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 点击操作
+
+GET /api/hid/click
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|x|query|integer| 是 ||点击坐标X|
+|y|query|integer| 是 ||点击坐标Y|
+|duration|query|integer| 是 ||持续时间|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 双击操作
+
+GET /api/hid/doubleClick
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|x|query|integer| 是 ||点击坐标X|
+|y|query|integer| 是 ||点击坐标Y|
+|duration|query|integer| 是 ||持续时间|
+|interval|query|integer| 否 ||间隔时间|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 滑动操作
+
+GET /api/hid/swipe
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|startX|query|integer| 是 ||起点X|
+|startY|query|integer| 是 ||起点Y|
+|endX|query|integer| 是 ||终点X|
+|endY|query|integer| 是 ||终点Y|
+|jitter|query|boolean| 是 ||是否开启抖动|
+|steps|query|integer| 是 ||抖动步数|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 获取当前在前台的App（仅 IOS18.2及以上）
+
+GET /api/hid/currentAppInfo
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 打开App
+
+GET /api/hid/openApp
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|name|query|string| 是 ||支持 app 名称和 app bundleId|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 关闭App
+
+GET /api/hid/closeApp
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|name|query|string| 是 ||支持 app 名称和 app bundleId|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 打开URL
+
+GET /api/hid/openURL
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|url|query|string| 是 ||none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 重启HID设备
+
+GET /api/hid/restartDevice
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 移动坐标
+
+GET /api/hid/move
+
+### 请求参数
+
+|名称|位置|类型|必选|中文名|说明|
+|---|---|---|---|---|---|
+|x|query|integer| 是 ||点击坐标X|
+|y|query|integer| 是 ||点击坐标Y|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 鼠标按下
+
+GET /api/hid/mouseDown
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+## GET 鼠标抬起
+
+GET /api/hid/mouseUp
+
+> 返回示例
+
+> 200 Response
+
+```json
+{
+  "success": true
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+状态码 **200**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» success|boolean|true|none|是否成功|none|
+
+# 数据模型
+
+<h2 id="tocS_软件状态">软件状态</h2>
+
+<a id="schema软件状态"></a>
+<a id="schema_软件状态"></a>
+<a id="tocS软件状态"></a>
+<a id="tocs软件状态"></a>
+
+```json
+{
+  "deviceIp": "string",
+  "screenInfo": {
+    "logicWidth": 0,
+    "logicHeight": 0,
+    "height": 0,
+    "width": 0,
+    "scale": 0
+  },
+  "deviceName": "string",
+  "batteryInfo": {
+    "level": 0,
+    "isCharging": true
+  },
+  "appName": "string",
+  "appBuildNumber": 0,
+  "appBundleId": "string",
+  "deviceModel": "string",
+  "agentConnected": true,
+  "isRun": true,
+  "isDebugMode": true,
+  "isAuth": true,
+  "isRecording": true,
+  "udid": "string",
+  "serverDeviceId": "string",
+  "isPipScriptControlEnabled": true,
+  "orientation": "PORTRAIT",
+  "osVersion": "string",
+  "ecid": "string",
+  "isVolumeControlEnabled": true,
+  "agentVersion": "string",
+  "appVersion": "string",
+  "serverType": "international",
+  "isHidConnected": true,
+  "isShowUI": true,
+  "isLogin": true,
+  "isPipWindowEnabled": true,
+  "deviceId": "string"
+}
+
+```
+
+### 属性
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|deviceIp|string|true|none|设备IP|none|
+|screenInfo|object|true|none|屏幕信息|none|
+|» logicWidth|integer|true|none|逻辑宽带|none|
+|» logicHeight|integer|true|none|逻辑高度|none|
+|» height|integer|true|none|物理高度|none|
+|» width|integer|true|none|物理宽度|none|
+|» scale|number|true|none|缩放比|none|
+|deviceName|string|true|none|设备名称|none|
+|batteryInfo|object|true|none|电池信息|none|
+|» level|integer|true|none|电量 1-100|none|
+|» isCharging|boolean|true|none|是否充电中|none|
+|appName|string|true|none|app名称|none|
+|appBuildNumber|integer|true|none|app构建号|none|
+|appBundleId|string|true|none|app 包名|none|
+|deviceModel|string|true|none|设备型号|none|
+|agentConnected|boolean|true|none|agent是否连接|none|
+|isRun|boolean|true|none|脚本是否启动|none|
+|isDebugMode|boolean|true|none|是否调试模式运行|none|
+|isAuth|boolean|true|none|是否授权|none|
+|isRecording|boolean|true|none|是否录屏中|none|
+|udid|string|true|none|设备唯一 UDID|none|
+|serverDeviceId|string|true|none|服务器设备ID|none|
+|isPipScriptControlEnabled|boolean|true|none|悬浮窗控制是否打开|none|
+|orientation|string|true|none|屏幕方向|none|
+|osVersion|string|true|none|系统版本|none|
+|ecid|string|true|none|设备唯一 ECID|none|
+|isVolumeControlEnabled|boolean|true|none|是否开启了音量键启停|none|
+|agentVersion|string|true|none|agent版本号|none|
+|appVersion|string|true|none|app版本号|none|
+|serverType|string|true|none|授权服务器类型|none|
+|isHidConnected|boolean|true|none|hid设备是否连接|none|
+|isShowUI|boolean|true|none|实现显示了 UI|none|
+|isLogin|boolean|true|none|是否登录|none|
+|isPipWindowEnabled|boolean|true|none|悬浮窗是否打开|none|
+|deviceId|string|true|none|设备 ID，应用唯一，卸载重装变化|none|
+
+#### 枚举值
+
+|属性|值|
+|---|---|
+|orientation|PORTRAIT|
+|orientation|LANDSCAPE|
+|serverType|international|
+|serverType|domestic|
+