帮助中心 >
通过 Open API 控制云手机
您可以通过 Open API 控制已经导入至花漾客户端中的云手机,并能为这些云手机开启 ADB 的端口映射服务。
为使用此功能,首先您需要在花漾客户端中开启 Open API 服务,更进一步信息请阅读 花漾客户端 Open API 服务 一文。
其次,您需要确保花漾客户端的版本至少在 “12.9.1043” 及以上版本。
1、获取云手机列表
GET /api/openapi/cloud-mobile/lis
无需参数。返回当前团队内有权访问的云手机,不包含本地手机和联营手机。
返回示例:
{
"success": true,
"code": 0,
"data": [
{
"id": 101,
"name": "手机1",
"udid": "example-mobile-001",
"seatId": 11,
"poweredOn": true
},
{
"id": 102,
"name": "手机2",
"udid": "example-mobile-002",
"seatId": 11,
"poweredOn": false
}
]
}
| 字段 | 说明 |
|---|---|
| id | 手机 ID,后两个接口中的 mobileId 就传这个值。 |
| name | 手机名称。 |
| udid | 业务手机标识,不是 ADB 连接地址。 |
| setId | 所属单元 ID;相同单元下的手机可据此分组,关联信息缺失时为 null。 |
| poweredOn | true:开机;false:关机;null:任务执行中、启停中或状态未知。 |
2、切换到目标云手机
POST /api/openapi/cloud-mobile/{mobileId}/activate?backup=true
请求体留空,服务端会自行查找所属单元。
| 参数 | 位置 | 说明 |
|---|---|---|
| mobileId | 路径,必填 | 目标手机的 id,不是手机序号、seatId 或 udid。 |
| backup | 查询参数,可选 | 是否备份,默认 true,仅在支持备份的切换流程中生效。建议保持默认值。 |
示例:从上面列表的手机1切换到手机2
POST /api/openapi/cloud-mobile/102/activate?backup=true
成功返回:
{
"success": true,
"code": 0
}
成功只表示请求已受理,不表示切换已完成。之后查询列表,确认目标手机 poweredOn 为 true,再获取 ADB 信息;等待期间不要重复提交切换请求。
不支持切换的手机会返回 success: false、code: 2008。
3、获取云手机 ADB 连接信息
POST /api/openapi/cloud-mobile/{mobileId}/adb
mobileId 填列表中的手机 id,请求体留空。请先确认手机已开机、切换已完成;此接口可能按需开启 ADB,不用于开机或切换手机。
示例:获取手机2的 ADB 信息
POST /api/openapi/cloud-mobile/102/adb
返回示例
{
"success": true,
"code": 0,
"data": {
"sshHost": "ssh.example.com",
"sshPort": 22,
"sshUsername": "example-user",
"sshPassword": "EXAMPLE_TEMPORARY_PASSWORD",
"remoteAdbHost": "127.0.0.1",
"remoteAdbPort": 5555,
"expireTime": "2030-01-01T01:00:00Z"
}
}
| 字段 | 说明 |
|---|---|
| sshHost | SSH 服务地址。 |
| sshPort | SSH 端口。 |
| sshUsername | SSH 用户名。 |
| sshPassword | SSH 临时密码。 |
| remoteAdbHost | 通过 SSH 隧道访问的远端 ADB 地址。 |
| remoteAdbPort | 远端 ADB 端口。 |
| expireTime | t连接凭据到期时间,UTC 日期字符串。 |
| validUntilTime | 可选,授权截止时间,毫秒时间戳。如果返回此字段,以它和 expireTime 中较早的时间为连接截止时间。 |
示例中的域名、密码和时间均为占位数据。返回信息含临时密码,请勿记录日志或持久化;到期或切换手机后,应重新获取连接信息。