基于移动云AK/SK认证
1、签名认证
目前云手机产品使用移动云开放API能力进行统一调用，使用移动云AccessKey/SecretKey进行身份验证，详请参考移动云官网说明 https://ecloud.10086.cn/op-help-center/doc/article/24283
云手机服务端相关接口
1、webrtc连接获取token
1.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/webrtc/token |
webrtc连接获取token |
1.2 URI参数说明
无
1.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
|
2 |
user_id |
String |
用户id |
可选 |
1.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
phoneId |
String |
云手机id |
必选 |
|
2 |
user |
String |
user |
可选 |
|
3 |
enableUserCheck |
Boolean |
是否开启用户级校验 |
可选 |
1.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
Object |
响应体 |
|
5.1 |
token |
String |
webrtc连接token |
|
5.2 |
target |
String |
webrtc连接的目的机器 |
1.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": { "token": "", "target": "" } } |
2、查询云手机列表
2.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/list |
查询云手机列表 |
2.2 URI参数说明
无
2.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
2.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
currentPage |
Integer |
页码 |
|
|
2 |
pageSize |
Integer |
每页条数 |
|
|
3 |
id |
String |
云手机主键ID |
|
|
4 |
name |
String |
云手机名称 |
|
|
5 |
specs |
String |
规格配置主键
|
|
|
6 |
imgVersion |
String |
镜像版本 |
|
|
7 |
hostIp |
String |
服务器IP |
|
|
8 |
osName |
String |
系统名称 |
|
|
9 |
orderType |
Integer |
计费类型：1包月计费、2包年计费 |
|
|
10 |
status |
Integer |
云手机状态（0已禁用、1正在开通、2运行中、3已关机、4已冻结、5已过期、6正在启动、7正在关机、8正在重启、9正在初始化，99异常） |
|
|
11 |
userId |
String |
用户ID
|
|
|
12 |
type |
Integer |
版本类型：3 |
必选 |
2.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
Object |
响应体 |
|
5.1 |
total |
Long |
结果总数量 |
|
5.2 |
totalPage |
Integer |
结果总页数 |
|
5.3 |
list |
List<Object> |
当前页数据 |
|
5.3.1 |
id |
String |
云手机实例ID |
|
5.3.2 |
status |
Integer |
云手机状态（0已禁用、1正在开通、2运行中、3已关机、4已冻结、5已过期、6正在启动、7正在关机、8正在重启、9正在初始化） |
|
5.3.3 |
specs |
String |
规格配置 |
|
5.3.4 |
bandwidth |
Integer |
|
|
5.3.5 |
imgVersion |
String |
镜像版本 |
|
5.3.6 |
osName |
String |
|
|
5.3.7 |
endTime |
Date |
到期时间 |
|
5.3.8 |
hostIp |
String |
服务器IP |
|
5.3.9 |
errorMsg |
String |
当状态为99异常时，应该有值 |
|
5.3.10 |
volumeId |
String |
绑定的云硬盘id |
|
5.3.11 |
bindStatus |
Integer |
绑定状态：0:未绑定，1:绑定中，2:已绑定，3:解绑中 |
2.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": { "total": 1, "totalPage": 1, "list": [ { "id": "1752997444282187778", "imgVersion": "1.0", "imgId": "1749712580854108162", "hostIp": "100.70.86.55", "osName": "aosp7", "status": 2, "specs": "2", "bandwidth": null, "createTime": "2024-02-01 18:08:54", "endTime": "2024-01-19 17:07:22", "errorMsg": null, "poolId": "CIDC-RP-25", "volumeId": "xxx" } ] } } |
3、查询云手机详情
3.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/detail |
查询云手机详情 |
3.2 URI参数说明
无
3.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
3.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
id |
String |
云手机ID |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
3.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|||
|
1 |
errorCode |
String |
错误编码 |
|||
|
2 |
errorMessage |
String |
错误信息 |
|||
|
3 |
requestId |
String |
请求id |
|||
|
4 |
state |
String |
状态值 |
|||
|
5 |
body |
Object |
响应体 |
|||
|
5.1 |
id |
String |
云手机实例ID |
|||
|
5.2 |
volumeId |
String |
绑定的云硬盘id |
|||
|
5.3 |
name |
String |
云手机名称 |
|||
|
5.4 |
status |
Integer |
云手机状态（0已禁用、1正在开通、2运行中、3已关机、4已冻结、5已过期、6正在启动、7正在关机、8正在重启、9正在初始化，99异常） |
|||
|
5.5 |
specs |
String |
规格配置 |
|||
|
5.6 |
bandwidth |
Integer |
带宽 |
|||
|
5.7 |
poolId |
String |
资源池ID |
|||
|
5.8 |
osName |
String |
系统名称 |
|||
|
5.9 |
imgVersion |
String |
镜像版本 |
|||
|
5.10 |
startTime |
Date |
开通时间 |
|||
|
5.11 |
endTime |
Date |
到期时间 |
|||
|
5.12 |
orderNo |
String |
订单编号（MOP-T） |
|||
|
5.13 |
errorMsg |
String |
当状态为99异常时，应该有值 |
|||
|
5.14 |
ipv4 |
String |
|
|||
|
5.15 |
ipv6 |
String |
|
|||
|
5.16 |
ports |
List |
端口 |
|||
|
5.16.1 |
protocol |
String |
端口协议（TCP/UDP） |
|||
|
5.16.2 |
port |
Integer |
|
|||
|
5.17 |
attribute |
Object |
云手机属性 |
|||
|
5.17.1 |
phoneId |
String |
云手机实例ID |
|||
|
5.17.2 |
byte_os_mainkeys |
int |
隐藏虚拟按键，默认为1，即不隐藏，0表示隐藏 |
|||
|
5.17.3 |
disable_status_bar |
int |
是否禁用状态栏，默认为0 |
|||
|
5.17.4 |
ro_byte_os_notification_disable |
int |
是否禁用消息通知，默认为0 |
|||
|
5.17.5 |
ro_permission_changed |
int |
是否在安装app时自动赋予App请求的所有权限，默认为0 |
|||
|
5.17.6 |
ro_install_auto |
int |
是否在App安装时自动确认安装，默认为0 |
|||
|
5.17.7 |
ro_byte_os_non_root |
int |
是否非root，默认为1 |
|||
|
5.17.8 |
ro_horizontal_screen |
int |
是否横屏显示，默认为0 |
|||
|
5.17.9 |
ro_byte_os_toast_enable |
int |
是否启用Toast消息提示框，默认为0 |
|||
|
5.17.10 |
sys_prop_writeimsi |
String |
IMSI（International Mobile Subscriber Identity，国际移动用户识别码） |
|||
|
5.17.11 |
sys_prop_imeid |
String |
meid（MEID（Mobile Equipment Identifier）是用于标识CDMA（Code Division Multiple Access）移动设备的唯⼀标识符） |
|||
|
5.17.12 |
sys_prop_writephonenum |
String |
手机号码 |
|||
|
5.17.13 |
sys_prop_writewifissid |
String |
无线网络名称 |
|||
|
5.17.14 |
sys_prop_writewifibssid |
String |
是在无线局域⽹（WLAN）中⽤于唯⼀标识基本服务集（BSS）的MAC地址 |
|||
|
5.17.15 |
gsm_sim_operator_iso_country |
String |
SIM卡归属国家，默认为cn |
|||
|
5.17.16 |
gsm_sim_operator_numeric |
String |
SIM卡提供商的标识码，默认为46000 |
|||
|
5.17.17 |
gsm_sim_operator_alpha |
String |
SIM卡的运营商，默认为CMCC |
|||
|
5.17.18 |
gsm_operator_iso_country |
String |
网络运营商国家代码，默认为cn |
|||
|
5.17.19 |
gsm_operator_numeric |
String |
网络提供商的标识码，默认为46000 |
|||
|
5.17.20 |
gsm_operator_alpha |
String |
网络运营商名称，默认为CMCC |
|||
|
5.18 |
bindStatus |
Integer |
绑定状态 |
|||
3.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "c27b9c35-9864-4298-a373-4595b6d37b01", "state": "OK", "body": { "id": "1772246296277094402", "name": "cp-31fb44a518b4401098244242d92cf71a", "status": 2, "specs": "2402271453029535", "bandwidth": null, "poolId": "CIDC-RP-45", "imgVersion": "2.1.1", "imgId": "1772209309847457793", "osName": "aosp11", "startTime": "2024-03-25 20:56:50", "endTime": "2024-04-25 20:56:50", "orderNo": "MOP-O-24032575123658", "errorMsg": null, "ipv4": "100.70.86.55", "ipv6": null, "ports": [ { "protocol": "TCP", "port": 40018 }, { "protocol": "UDP", "port": 50072 }, { "protocol": "UDP", "port": 50073 }, { "protocol": "UDP", "port": 50074 }, { "protocol": "UDP", "port": 50075 } ], "attribute": { "phoneId": "1772246296277094402", "byte_os_mainkeys": 1, "disable_status_bar": 0, "ro_permission_changed": 0, "ro_install_auto": 0, "ro_byte_os_non_root": 1, "ro_byte_os_notification_disable": 0, "ro_byte_os_toast_enable": 0, "sys_prop_writeimsi": null, "sys_prop_imeid": null, "sys_prop_writephonenum": null, "sys_prop_writewifissid": null, "sys_prop_writewifibssid": null, "gsm_sim_operator_iso_country": "cn", "gsm_sim_operator_numeric": "46000", "gsm_sim_operator_alpha": "CMCC", "gsm_operator_iso_country": "cn", "gsm_operator_numeric": "46000", "gsm_operator_alpha": "CMCC", "ro_horizontal_screen": 0 }, "volumeId": "96f2f94d-c707-4c40-9336-1c3e63655abc", "bindStatus": 2 } } |
4、修改云手机名称
4.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/rename |
查询云手机详情 |
4.2 URI参数说明
无
4.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
4.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
id |
String |
云手机ID |
必选 |
|
2 |
name |
String |
云手机名称 |
必选 |
|
3 |
type |
Integer |
版本类型：3 |
必选 |
4.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
Object |
响应体 |
4.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": true } |
5、云手机状态管理
5.1 云手机开机操作接口
5.2 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/start |
云手机开机操作接口 |
5.3 URI参数说明
无
5.4 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
5.5 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
ids |
List<String> |
云手机实例ID列表 |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
5.6 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
Integer |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
5.7 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
6、云手机关机操作接口
6.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/close |
云手机实例关机操作接口 |
6.2 URI参数说明
无
6.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
6.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
ids |
List<String> |
云手机实例ID列表 |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
6.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
6.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
7、云手机重启操作接口
7.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/reboot |
云手机实例重启操作接口 |
7.2 URI参数说明
无
7.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
7.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
ids |
List<String> |
云手机实例ID列表 |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
7.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
7.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
8、云手机初始化操作接口
8.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/init |
云手机实例初始化操作接口 |
8.2 URI参数说明
无
8.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
8.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
ids |
List<String> |
云手机实例ID列表 |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
8.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
8.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body":[ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
9、云手机重启操作接口（包括更换镜像（可选）、更新属性（可选）、重启操作）
9.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/restart |
云手机实例重启操作接口（可选更换镜像、更新属性） |
9.2 URI参数说明
无
9.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
9.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
phones |
List<Object> |
云手机实例列表 |
必选 |
|
1.1 |
id |
String |
云手机实例id |
必选 |
|
1.2 |
byte_os_mainkeys |
Integer |
隐藏虚拟按键，默认为1，即不隐藏，0表示隐藏 |
可选 |
|
1.3 |
disable_status_bar |
Integer |
是否禁用状态栏，默认为0 |
可选 |
|
1.4 |
ro_byte_os_notification_disable |
Integer |
是否禁用消息通知，默认为0 |
可选 |
|
1.5 |
ro_permission_changed |
Integer |
是否在安装app时自动赋予App请求的所有权限，默认为0 |
可选 |
|
1.6 |
ro_install_auto |
Integer |
是否在App安装时自动确认安装，默认为0 |
可选 |
|
1.7 |
ro_byte_os_non_root |
Integer |
是否非root，默认为1 |
可选 |
|
1.8 |
ro_horizontal_screen |
Integer |
是否横屏显示，默认为0 |
可选 |
|
1.9 |
ro_byte_os_toast_enable |
Integer |
是否启用Toast消息提示框，默认为0 |
可选 |
|
1.10 |
sys_prop_writeimsi |
String |
IMSI（International Mobile Subscriber Identity，国际移动用户识别码） |
可选 |
|
1.11 |
sys_prop_imeid |
String |
meid（MEID（Mobile Equipment Identifier）是用于标识CDMA（Code Division Multiple Access）移动设备的唯⼀标识符） |
可选 |
|
1.12 |
sys_prop_writephonenum |
String |
手机号码 |
可选 |
|
1.13 |
sys_prop_writewifissid |
String |
无线网络名称 |
可选 |
|
1.14 |
sys_prop_writewifibssid |
String |
是在无线局域⽹（WLAN）中⽤于唯⼀标识基本服务集（BSS）的MAC地址 |
可选 |
|
1.15 |
gsm_sim_operator_iso_country |
String |
SIM卡归属国家，默认为cn |
可选 |
|
1.16 |
gsm_sim_operator_numeric |
String |
SIM卡提供商的标识码，默认为46000 |
可选 |
|
1.17 |
gsm_sim_operator_alpha |
String |
SIM卡的运营商，默认为CMCC |
可选 |
|
1.18 |
gsm_operator_iso_country |
String |
网络运营商国家代码，默认为cn |
可选 |
|
1.19 |
gsm_operator_numeric |
String |
网络提供商的标识码，默认为46000 |
可选 |
|
1.20 |
gsm_operator_alpha |
String |
网络运营商名称，默认为CMCC |
可选 |
|
2 |
imageId |
Long |
云手机镜像ID |
可选 |
|
3 |
type |
Integer |
版本类型：3 |
必选 |
9.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
9.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
10、云手机初始化操作接口（包括更换镜像（可选）、更新属性（可选）、初始化操作）
10.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/reset |
云手机实例初始化操作接口 |
10.2 URI参数说明
无
10.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
10.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
phones |
List<Object> |
云手机实例列表 |
必选 |
|
1.1 |
id |
String |
云手机实例id |
必选 |
|
1.2 |
byte_os_mainkeys |
Integer |
隐藏虚拟按键，默认为1，即不隐藏，0表示隐藏 |
可选 |
|
1.3 |
disable_status_bar |
Integer |
是否禁用状态栏，默认为0 |
可选 |
|
1.4 |
ro_byte_os_notification_disable |
Integer |
是否禁用消息通知，默认为0 |
可选 |
|
1.5 |
ro_permission_changed |
Integer |
是否在安装app时自动赋予App请求的所有权限，默认为0 |
可选 |
|
1.6 |
ro_install_auto |
Integer |
是否在App安装时自动确认安装，默认为0 |
可选 |
|
1.7 |
ro_byte_os_non_root |
Integer |
是否非root，默认为1 |
可选 |
|
1.8 |
ro_horizontal_screen |
Integer |
是否横屏显示，默认为0 |
可选 |
|
1.9 |
ro_byte_os_toast_enable |
Integer |
是否启用Toast消息提示框，默认为0 |
可选 |
|
1.10 |
sys_prop_writeimsi |
String |
IMSI（International Mobile Subscriber Identity，国际移动用户识别码） |
可选 |
|
1.11 |
sys_prop_imeid |
String |
meid（MEID（Mobile Equipment Identifier）是用于标识CDMA（Code Division Multiple Access）移动设备的唯⼀标识符） |
可选 |
|
1.12 |
sys_prop_writephonenum |
String |
手机号码 |
可选 |
|
1.13 |
sys_prop_writewifissid |
String |
无线网络名称 |
可选 |
|
1.14 |
sys_prop_writewifibssid |
String |
是在无线局域⽹（WLAN）中⽤于唯⼀标识基本服务集（BSS）的MAC地址 |
可选 |
|
1.15 |
gsm_sim_operator_iso_country |
String |
SIM卡归属国家，默认为cn |
可选 |
|
1.16 |
gsm_sim_operator_numeric |
String |
SIM卡提供商的标识码，默认为46000 |
可选 |
|
1.17 |
gsm_sim_operator_alpha |
String |
SIM卡的运营商，默认为CMCC |
可选 |
|
1.18 |
gsm_operator_iso_country |
String |
网络运营商国家代码，默认为cn |
可选 |
|
1.19 |
gsm_operator_numeric |
String |
网络提供商的标识码，默认为46000 |
可选 |
|
1.20 |
gsm_operator_alpha |
String |
网络运营商名称，默认为CMCC |
可选 |
|
2 |
imageId |
Long |
云手机镜像ID |
可选 |
|
3 |
type |
Integer |
版本类型：3 |
必选 |
10.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
10.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body":[ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
11、云手机属性管理
11.1 云手机启用、禁用操作接口
11.2 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/active |
云手机实例初始化操作接口 |
11.3 URI参数说明
无
11.4 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
11.5 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
ids |
List<string> |
云手机实例ID列表 |
必选 |
|
2 |
active |
Integer |
1启用，0禁用 |
必选 |
|
3 |
type |
Integer |
版本类型：3 |
必选 |
11.6 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
11.7 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
12、云手机更换镜像接口
12.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/attributes/changeImage |
云手机更换镜像接口 |
12.2 URI参数说明
无
12.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
12.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
ids |
List<String> |
云手机实例ID列表 |
必选 |
|
2 |
imageId |
Long |
云手机镜像ID |
必选 |
|
3 |
type |
Integer |
版本类型：3 |
必选 |
12.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
12.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
13、云手机属性查看接口
13.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/attributes/view |
云手机属性查看接口 |
13.2 URI参数说明
无
13.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
13.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
id |
String |
云手机实例id
|
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
13.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
Object |
响应体 |
|
5.1 |
phoneId |
String |
云手机实例ID |
|
5.2 |
byte_os_mainkeys |
int |
隐藏虚拟按键，默认为1，即不隐藏，0表示隐藏 |
|
5.3 |
disable_status_bar |
int |
是否禁用状态栏，默认为0 |
|
5.4 |
ro_byte_os_notification_disable |
int |
是否禁用消息通知，默认为0 |
|
5.5 |
ro_permission_changed |
int |
是否在安装app时自动赋予App请求的所有权限，默认为0 |
|
5.6 |
ro_install_auto |
int |
是否在App安装时自动确认安装，默认为0 |
|
5.7 |
ro_byte_os_non_root |
int |
是否非root，默认为1 |
|
5.8 |
ro_horizontal_screen |
int |
是否横屏显示，默认为0 |
|
5.9 |
ro_byte_os_toast_enable |
int |
是否启用Toast消息提示框，默认为0 |
|
5.10 |
sys_prop_writeimsi |
String |
IMSI（International Mobile Subscriber Identity，国际移动用户识别码） |
|
5.11 |
sys_prop_imeid |
String |
meid（MEID（Mobile Equipment Identifier）是用于标识CDMA（Code Division Multiple Access）移动设备的唯⼀标识符） |
|
5.12 |
sys_prop_writephonenum |
String |
手机号码 |
|
5.13 |
sys_prop_writewifissid |
String |
无线网络名称 |
|
5.14 |
sys_prop_writewifibssid |
String |
是在无线局域⽹（WLAN）中⽤于唯⼀标识基本服务集（BSS）的MAC地址 |
|
5.15 |
gsm_sim_operator_iso_country |
String |
SIM卡归属国家，默认为cn |
|
5.16 |
gsm_sim_operator_numeric |
String |
SIM卡提供商的标识码，默认为46000 |
|
5.17 |
gsm_sim_operator_alpha |
String |
SIM卡的运营商，默认为CMCC |
|
5.18 |
gsm_operator_iso_country |
String |
网络运营商国家代码，默认为cn |
|
5.19 |
gsm_operator_numeric |
String |
网络提供商的标识码，默认为46000 |
|
5.20 |
gsm_operator_alpha |
String |
网络运营商名称，默认为CMCC |
13.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "d82b8833-c00c-484d-a152-285bafb0636f", "state": "OK", "body": { "phoneId": "1772246296277094402", "byte_os_mainkeys": 1, "disable_status_bar": 0, "ro_permission_changed": 0, "ro_install_auto": 0, "ro_byte_os_non_root": 1, "ro_byte_os_notification_disable": 0, "ro_byte_os_toast_enable": 0, "sys_prop_writeimsi": null, "sys_prop_imeid": null, "sys_prop_writephonenum": null, "sys_prop_writewifissid": null, "sys_prop_writewifibssid": null, "gsm_sim_operator_iso_country": "cn", "gsm_sim_operator_numeric": "46000", "gsm_sim_operator_alpha": "CMCC", "gsm_operator_iso_country": "cn", "gsm_operator_numeric": "46000", "gsm_operator_alpha": "CMCC", "ro_horizontal_screen": 0 } } |
14、云手机属性更新接口
14.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/attributes/update |
云手机属性更新接口 |
14.2 URI参数说明
无
14.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
14.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
id |
String |
云手机实例ID |
必选 |
|
2 |
byte_os_mainkeys |
Integer |
隐藏虚拟按键，默认为1，即不隐藏，0表示隐藏 |
可选 |
|
3 |
disable_status_bar |
Integer |
是否禁用状态栏，默认为0 |
可选 |
|
4 |
ro_byte_os_notification_disable |
Integer |
是否禁用消息通知，默认为0 |
可选 |
|
5 |
ro_permission_changed |
Integer |
是否在安装app时自动赋予App请求的所有权限，默认为0 |
可选 |
|
6 |
ro_install_auto |
Integer |
是否在App安装时自动确认安装，默认为0 |
可选 |
|
7 |
ro_byte_os_non_root |
Integer |
是否非root，默认为1 |
可选 |
|
8 |
ro_horizontal_screen |
Integer |
是否横屏显示，默认为0 |
可选 |
|
9 |
ro_byte_os_toast_enable |
Integer |
是否启用Toast消息提示框，默认为0 |
可选 |
|
10 |
sys_prop_writeimsi |
String |
IMSI（International Mobile Subscriber Identity，国际移动用户识别码） |
可选 |
|
11 |
sys_prop_imeid |
String |
meid（MEID（Mobile Equipment Identifier）是用于标识CDMA（Code Division Multiple Access）移动设备的唯⼀标识符） |
可选 |
|
12 |
sys_prop_writephonenum |
String |
手机号码 |
可选 |
|
13 |
sys_prop_writewifissid |
String |
无线网络名称 |
可选 |
|
14 |
sys_prop_writewifibssid |
String |
是在无线局域⽹（WLAN）中⽤于唯⼀标识基本服务集（BSS）的MAC地址 |
可选 |
|
15 |
gsm_sim_operator_iso_country |
String |
SIM卡归属国家，默认为cn |
可选 |
|
16 |
gsm_sim_operator_numeric |
String |
SIM卡提供商的标识码，默认为46000 |
可选 |
|
17 |
gsm_sim_operator_alpha |
String |
SIM卡的运营商，默认为CMCC |
可选 |
|
18 |
gsm_operator_iso_country |
String |
网络运营商国家代码，默认为cn |
可选 |
|
19 |
gsm_operator_numeric |
String |
网络提供商的标识码，默认为46000 |
可选 |
|
20 |
gsm_operator_alpha |
String |
网络运营商名称，默认为CMCC |
可选 |
|
21 |
type |
Integer |
版本类型：3 |
必选 |
14.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
Object |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
14.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": { "id": "1752997444282187778", "jobId": "1.0", "errorCode": null, "errorMsg": null } } |
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": { "id": "1752997444282187778", "jobId": null, "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } } |
15、查询云手机规格列表
15.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/specs/list |
云手机规格配置列表 |
15.2 URI参数说明
无
15.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
15.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
type |
Integer |
版本类型：3 |
必选 |
15.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
Object |
响应体 |
|
5.1 |
id |
String |
规格主键ID |
|
5.2 |
specs |
String |
云手机规格编码，对应局数据chaId |
|
5.3 |
name |
String |
规格名称 |
|
5.4 |
grade |
Integer |
规格级别高低 |
|
5.5 |
maxCpu |
Integer |
最大cpu |
|
5.6 |
maxMemory |
Integer |
最大内存 |
|
5.7 |
minCpu |
Integer |
最小CPU |
|
5.8 |
minMemory |
Integer |
最小内存 |
|
5.9 |
storage |
Integer |
存储 |
|
5.10 |
bandwidth |
String |
带宽 |
|
5.11 |
resolutionWidth |
Integer |
分辨率宽 |
|
5.12 |
resolutionHeight |
Integer |
分辨率高 |
15.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": { "total": 5, "totalPage": 1, "list": [ { "id": 1, "isDelete": 0, "description": null, "specs": "1", "name": "标准版（2C4G 32G存储）", "grade": 1, "bandwidth": null, "maxCpu": 2, "maxMemory": 4, "minCpu": 1, "minMemory": 2, "storage": 32 } } |
16、云手机应用管理
16.1 获取云手机内已安装应用列表接口
16.2 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/apps/list |
获取云手机内已安装应用列表接口 |
16.3 URI参数说明
无
16.4 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
16.5 请求消息体参数说明
|
名称 |
类型 |
描述 |
必选\可选 |
|
phoneIds |
List<String> |
云手机实例 |
必选 |
|
appName |
String |
应用名称 |
可选 |
|
pageSize |
Integer |
|
必传 |
|
currentPage |
Integer |
|
必传 |
|
type |
Integer |
版本类型：3 |
必选 |
16.6 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
6 |
body |
List<Object> |
响应体 |
|
6.1 |
phoneId |
String |
云手机主键ID |
|
6.2 |
appId |
String |
应用表主键ID |
|
6.3 |
appName |
String |
应用名称 |
|
6.4 |
packageName |
String |
应用包名 |
|
6.5 |
size |
int |
应用大小(MB) |
|
6.6 |
version |
String |
应用版本 |
|
6.7 |
id |
String |
云手机已安装应用表主键 |
16.7 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "body": { "total": 1, "totalPage": 1, "list": [ { "id": "1753298677693968386", "phoneId": "1753007232487489538", "appId": "1735130048727625730", "appName": "APKPure", "appPackageName": "com.apkpure.aegon", "appSize": "10", "appVersion": "3.19.65" } ] }, "requestId": "d05b196a-6508-4eff-b989-316c93d3a27e", "state": "ok" } |
17、云手机应用安装接口
17.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/apps/install |
云手机应用安装接口 |
17.2 URI参数说明
无
17.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
17.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
phoneIds |
List<String> |
云手机主键ID列表 |
必选 |
|
2 |
fileName |
String |
原文件名称 |
可选 |
|
3 |
appName |
String |
应用名称 |
必选 |
|
4 |
appPackageName |
String |
应用包名称 |
必选 |
|
5 |
appSize |
String |
应用包大小（MB） |
必选 |
|
6 |
appVersion |
String |
应用版本号 |
必选 |
|
7 |
bucketName |
String |
对象存储桶名称 |
必选 |
|
8 |
etag |
String |
对象存储上传对象的实体标记 |
可选 |
|
9 |
type |
Integer |
版本类型：3 |
必选 |
|
10 |
downloadUrl |
String |
对象存储文件地址 |
可选 |
|
11 |
filePath |
String |
对象存储中文件路径 |
必选 |
17.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
17.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
18、云手机应用卸载接口
18.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/apps/uninstall |
云手机应用卸载接口 |
18.2 URI参数说明
无
18.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
18.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
phoneIds |
List<String> |
云手机实例id |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
|
3 |
packageName |
String |
App包名 |
必选 |
18.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
18.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body":[ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
19、云手机绑定
19.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/bind |
云手机绑定 |
19.2 URI参数说明
无
19.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
19.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
phoneIds |
Array |
云手机ID集合 |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
19.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
19.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
20、云手机解绑
20.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/unbind |
云手机解绑 |
20.2 URI参数说明
无
20.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
20.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
phoneIds |
array |
云手机ID集合 |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
20.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
20.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
21、推送文件
21.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/push |
推送文件 |
21.2 URI参数说明
无
21.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
21.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
ids |
List<String> |
云手机ids |
必选 |
|
2 |
content |
String |
推送的文件只支持tar文件类型，指定OBS桶中的tar文件。 最大长度为1024字节，只支持大小写字母、数字、下划线（_）、点（.）、斜线（/）、冒号（:）、中划线（-）。文件格式：obs://obs-bucket-name/obs-file-path/file.tar。 |
必选 |
|
3 |
type |
Integer |
版本类型：3 |
必选 |
21.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
id |
String |
云手机ID |
|
5.2 |
jobId |
String |
任务id |
|
5.3 |
errorCode |
String |
任务错误码。 |
|
5.4 |
errorMsg |
String |
任务错误码说明。 |
21.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": [ { "id": "1752997444282187778", "jobId": "1.0" }, { "id": "1752997444282187778", "errorCode": "1749712580854108162", "errorMsg": "100.70.86.55" } ] } |
22、查看规格实例数量
22.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/queryInstanceNum |
查询规格实例数量 |
22.2 URI参数说明
无
22.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
22.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
specs |
String |
云手机规格编码，对应局数据chaId |
必选 |
|
2 |
type |
Integer |
版本类型：3 |
必选 |
22.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List<Object> |
响应体 |
|
5.1 |
specs |
String |
云手机规格编码，对应局数据chaId |
|
5.2 |
InstanceNum |
integer |
实例数量 |
|
5.3 |
measureUnit |
String |
包年、包月 |
|
5.4 |
serviceName |
String |
规格名称 |
22.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body": { "specs": "xx", "instanceNum": 100, "measureUnit": "xx", "serviceName": "xx" } } |
|
|
23、查看pod信息
23.1 请求方法和URI
|
请求方法 |
URI |
描述 |
|
POST |
/api/openapi-cloudphone/api/v1/zycloudphone/resource/gly/phones/queryPodInfo |
查询pod信息 |
23.2 URI参数说明
无
23.3 header参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
pool |
String |
资源池 |
必选 |
23.4 请求消息体参数说明
|
|
名称 |
类型 |
描述 |
必选\可选 |
|
1 |
podName |
String |
容器名称 |
必选 |
23.5 响应消息体参数说明
|
|
名称 |
类型 |
描述 |
|
1 |
errorCode |
String |
错误编码 |
|
2 |
errorMessage |
String |
错误信息 |
|
3 |
requestId |
String |
请求id |
|
4 |
state |
String |
状态值 |
|
5 |
body |
List |
响应体 |
|
5.1 |
ipv4
|
String |
公网ipv4 |
|
5.2 |
ipv6
|
String |
公网ipv |
|
5.3 |
port
|
int |
端口信息 |
|
5.4 |
phoneId
|
String |
云手机id |
|
5.5 |
protocol
|
String |
协议 |
|
5.6 |
hostIp
|
String |
主机ip |
23.6 响应消息体示例
|
{ "errorCode": "00000000", "errorMessage": "请求成功", "requestId": "972f4020-f4dd-476d-b37c-0487c9466fbc", "state": "ok", "body":{ “podName”:”xx”, “ip”:”xx”， “port”:100 } } |
H5 SDK
1、项目背景
云手机端云相关部分SDK, 致力于提供快速高效的接入方案，遵循原则： 最小可用性、最少依赖、安全稳定、易扩展，可诊断
本文档面向H5开发者，用于指导开发者快速接入云手机SDK，开发自己的云手机产品。
2、H5 SDK下载
3、引入H5 SDK包
3.1 引入说明
暂时以js的形式作为一个示例：
<script src="./out/cloud-sdk.min.js"></script>
4 相关接口列表
4.1 获取环境是否支持接口
· 接口介绍
CloudPhone.isSupport();
· 功能描述
获取当前环境是否满足 SDK 运行。该方法不依赖实例
4.2 创建SDK应用连接实例接口
· 接口介绍
const cloudPhone = new CloudPhone(params: ParamsObj)
· 功能描述
创建云机连接实例，创建的过程中会自动和信令建立连接
· 参数介绍
@param {object} params：初始化实例相关配置，必选
|
参数 |
是否必选 |
参数类型 |
描述 |
|
containerId |
否 |
String |
video标签的ID字符串，会自动注册触控事件 |
|
peerId |
是 |
String |
云机实例ID、示例：1e2615a214a143af8a9051ff16881d6c |
|
cloudId |
否 |
String |
云机订单ID、示例：i25c39lv |
|
userId |
否 |
String |
用户ID、示例：18343 |
|
websocket |
是 |
SocketOption |
信令服务器相关信息，相关描述参考下表1 |
|
debug |
否 |
String |
日志等级, 可用：Disabled、 Errors、Warnings 、All |
|
token |
是 |
String |
鉴权秘钥 |
|
deviceId |
否 |
String |
设备ID，浏览器唯一秘钥，不传会使用默认生成 |
|
packageName |
否 |
String |
包名，部分场景需要进入云机自动打开APP |
|
phoneInfo |
否 |
PhoneInfo |
云机相关配置，相关描述参考下表2 |
表1： SocketOption 信令参数配置
|
参数 |
是否必选 |
参数类型 |
描述 |
|
secure |
否 |
boolean |
true使用wss,false使用false,如果不传会以http的协议头作为判断 |
|
host |
否 |
String |
域名，示例：'tcloud.qknode.com' |
|
path |
否 |
String |
路径，示例：'/signal' |
|
query |
是 |
Object |
额外参数，和常规路由的query一样的定义，client_id要保持唯一性 |
表2： PhoneInfo： 云机相关配置
|
参数 |
是否必选 |
参数类型 |
描述 |
|
deviceResolution |
是 |
{width: number, height: number} |
云机物理分辨率的宽高, 8的倍数 |
|
H264Resolution |
是 |
{width: number, height: number} |
H264视频流的宽高， 8的倍数 |
|
mockCamera |
是 |
boolean |
是否仿真摄像头,还不可用 |
|
mockMicro |
是 |
boolean |
是否仿真麦克风 |
|
mockSensor |
是 |
boolean |
是否仿真传感器 |
|
mockGps |
是 |
boolean |
是否仿真GPS |
· 调用示例：
const cloudPhone = new cloudSDK.CloudPhone({ containerId: 'video',
peerId: 'pod-1bzb-498926b32ca449f79e92bd33ac4421ea', debug: 'All',
token: 'eyJwaG9uZUlkIjoiMTgxOTI2NjE0OTMxMDE5Nzc2MSIsInRlbmFudCI6IkNJREMtVS0yODVhOGYzMDJkZjI0Y2Y2OTg2 deviceId: '7313458746313182',
websocket: { // wss://ecloud.10086.cn/api/query/zycloudphone/ws/signal?client_id=7313458746313182&component=h5
secure: true,
host: 'ecloud.10086.cn',
path: '/api/web/zycloudphone/ws/signal', query: {
client_id: '7313458746313182', component: 'h5'
}
},
phoneInfo: { deviceResolution: {
width: 720,
height: 1208
},
H264Resolution: { width: 720,
height: 1208
},
mockCamera: true, mockMicro: true, mockSensor: true, mockGps: true
}
});4.3 重新连接云手机接口
· 接口介绍
cloudPhone.reconnect();
· 功能描述
重新连接云手机。
4.4 退出云手机接口
· 接口介绍
cloudPhone.exit();
· 功能描述
退出云手机。
4.5 设置云手机声音开关接口
· 接口介绍
cloudPhone.setMuted(muted: boolean);
· 功能描述
设置是否静音，当设置为false后，需要注意大部分浏览器需要用户交互之后（浏览器隐私政策限制），否则会出现无效的情况，尽量在产品层级做出友好提示。
4.6 设置视频流参数和画面质量接口
· 接口介绍
cloudPhone.setVideoParams(params);
· 功能描述
云机运行中设置视频流相关的指标，可以动态调整
@param {object} params：启动相关配置，必选
|
参数 |
是否必选 |
参数类型 |
描述 |
|
bitrate |
否 |
String |
码率：最小不小于1000000，最大不超过10000000 |
|
gopSize2 |
否 |
String |
I帧间隔：一般为10的倍数， |
|
rcMode2 |
否 |
String |
流控模式默认ABR， 解释：0：ABR, 平均码率 1： CRF, 画质优先 2： CBR, 恒定码率 3： CAPPED_CRF 画质优先，但限制码率 |
4.7 获取音视频流回调接口
· 接口介绍
cloudPhone.on('Stream', (stream: MediaStream) => {
// 音视频流通道
});
· 功能描述
获取云机连接成功后的音视频流参数，可以自行处理stream对象。用于前置处理后再展示到前台，这里最好containerId独立。
4.8 云机粘贴板内容回调接口
· 接口介绍
cloudPhone.on('ClipboardMessage', (msg: string) => {
// msg就是粘贴板最新的内容
});
· 功能描述
获取云机粘贴板变化回调，可以用来设置真机的粘贴板，已达到仿真的效果。
4.9 云机桌面接口
· 接口介绍
cloudPhone.home();
· 功能描述
进入云手机桌面。
4.10 云机返回接口
· 接口介绍
cloudPhone.back();
· 功能描述
应用退出、返回上一步。
4.11 云机任务列表接口
· 接口介绍
cloudPhone.menu();
· 功能描述
进入云手机多任务页面。
4.12 SDK内部错误回调接口
· 接口介绍
cloudPhone.on('Error', (error: { msg: string; code: PeerErrorCode }) => {
// 对错误信息做处理
});
· 功能描述
云机内部SDK错误回调，用于处理异常场景
· 错误码补充
export enum PeerErrCode {
/** 信令服务无响应 */
Crash = 0,
/** 控制端分享失效 */
Expired = 1002,
/** 鉴权失效 */
Auth = 1003,
/** 用户已在房间 */
Exist = 1004,
/** 云机不可达，大概率是云机服务挂掉了 */
Unreachable = 2002,
/** DC通道断开 */
DCDisconnect = 9001,
/** 云机被占用 */
IsUsed = 9002,
/** 浏览器环境不支持 */
NotSupport = 9003,
/** 解码异常 */
DecodeError = 9004,
/** 网络在线 -> 断开 */
Offline = 9005
}
4.13 获取云侧版本信息接口
· 接口介绍
cloudPhone.getRemoteVersion();
· 功能描述
获取云测SDK信息。
4.14 获取H5-SDK版本信息接口
· 接口介绍
cloudPhone.getVersion();
· 功能描述
获取H5端测SDK信息。
4.15 获取PeerConnection对象接口
· 接口介绍
const peerConnection = cloudPhone.getPeerConnection();
· 功能描述
获取PeerConnection，可以自行处理部分状态。
4.16 获取DataChannel对象接口
· 接口介绍
cloudPhone.on('DataChannelReady', (dataChannel: string) => {
// 接收云测最新消息
});
· 功能描述
获取DataChannel，可以自行处理部分状态。
4.17获取WebSocket对象接口
· 接口介绍
const websocket = cloudPhone.getWebSocket();
· 功能描述
获取Websocket对象，可以自定处理部分状态。
4.18 向云机发送字符串消息接口
· 接口介绍
cloudPhone.sendStringMsg(msg: string);
· 功能描述
向云机发送P2P DataChannel 消息，该方法约束传输类型字符串。
4.19 向云机发送文件流相关消息接口
· 接口介绍
cloudPhone.sendArrayBufferMsg(data: ArrayBuffer);
· 功能描述
向云机发送P2P DataChannel 消息，该方法约束传输类型ArrayBuffer, 目前这个方法可以用来传输文件，麦克风数据，摄像头数据。
4.20 开启传感器仿真接口
· 接口介绍
cloudPhone.mockSensor(fps: number); // 发送频率，毫秒
· 功能描述
开启仿真器仿真，尽全力交付传感数据至云手机。当前只支持加速传感器和陀螺仪传感器，其他传感器数据受限于浏览器无法获取。
4.21 关闭传感器仿真接口
· 接口介绍
cloudPhone.banSensor();
· 功能描述
关闭传感器仿真。
4.22 云机消息回调接口
· 接口介绍
cloudPhone.on('CloudMessage', (msg: string) => {
// 接收云测最新消息
});
· 功能描述
接收云机P2P DataChannel消息回调。
4.23 截图接口
· 接口介绍
cloudPhone.screenShot();
· 功能描述
截图功能，当前OS未做截图动画，指令执行在相册可以看到效果。
4.24 根据包名打开云机应用接口
· 接口介绍
cloudPhone.openOsApp(packageName: string);
· 功能描述
云机根据包名打开应用，设置应用的包名：com.android.settings。
4.25 旋转功能接口
· 接口介绍
cloudPhone.videoInstance.rotate(angle: number)
· 功能描述
一般来说不会主动去旋转视频流的方向，除非在一些特殊的设备上面，云机在PC上面播放横屏视频会自动旋转，当前版本暂时只支持270度旋转和不旋转。请查看demo观看效果。该API暂时挂在Video实例下面。
4.26 重置分辨率的需求接口
· 接口介绍
cloudPhone.resetPhysicalResolution(width: number, height: number)
· 功能描述
连接过程中如果需要改变云机的物理分辨率可以使用该API, 该API需要新版SDK支持。
5、调试云机常用命令
5.1 重启云机(举例北京11号云机)
cd /home/kbox_video_24_3_4 ./cfct_video restart 11（云机编号）
5.2 进入相应云机
docker exec -it android_11 sh