接口说明
对指定id的云手机执行一键HOME操作。即用户将云手机快速返回主屏幕。 注意： 1. 本接口属于异步任务接口，返回结果只有任务id。查询该任务的执行状态需要客户配置回调信息，或者根据任务id调用“查询任务执行状态详情/列表”接口来实现； 2. 状态为“运行中”的云手机才能调用此接口；
URL
POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/home
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
req
|
OpenapiCloudPhoneHomeReq
|
是
|
req |
|
callbackUrl
|
string
|
否
|
回调url，如http://192.168.0.1:5556/api/callback，needCallback为true才能生效 |
|
needAuth
|
boolean
|
否
|
是否需要鉴权 |
|
needCallback
|
boolean
|
否
|
是否需要回调 |
|
phoneIds
|
<string> array
|
是
|
云手机实例id列表 |
请求示例
POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/home{
"phoneIds":[
"1915236012589363201"
],
"needCallback":true,
"callbackUrl":"http://192.168.0.1:5556/api/callback",
"needAuth":true
}返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
<OpenapiCloudPhoneJobResultDto> array
|
响应体 |
|
errorCode
|
string
|
任务错误码 |
|
errorMsg
|
string
|
任务错误码说明 |
|
id
|
string
|
云手机ID |
|
jobId
|
string
|
任务ID |
|
errorCode
|
string
|
错误编码 |
|
errorMessage
|
string
|
错误信息 |
|
requestId
|
string
|
请求id |
|
state
|
string
|
状态值 |
返回示例
返回码：200
OK
{
"errorCode":"00000000",
"errorMessage":"请求成功",
"requestId":"188299c9-a310-467b-82d8-1e7b2a20dee7",
"state":"OK",
"body":[
{
"id":"1915236012589363201",
"jobId":"1920295175128604674",
"errorCode":null,
"errorMsg":null
}
]
}