Skip to content
API Reference
/
Cloud Phones
/
/Apps

Install app on cloud phone

Request

Install an app from the team app library onto a Cloud Phone.

  • Preconditions: the phone must be powered on and not held by another member. The app must already exist in the team library or the public catalogue — identify it either by appVersionId, or by packageName plus versionCode. The app must also be available for installation on this phone, otherwise installation fails.
  • Rate limit: at most one install per phone per second; a faster second call is rejected.
  • Completion: accepted, not complete. The response only confirms the request was queued. Poll /cloudphone/app/installedList to see whether the app arrived.
  • Retry: safe to retry after checking the installed list, subject to the one-per-second limit.

Documented business errors: 33005, 33014, 33714. See Error Codes for what each code means. Any operation can additionally return the common codes.

Bodyapplication/json
appVersionIdstring

App version ID

idstringrequired

Cloud phone ID

packageNamestring

Package name — required only if appVersionId is not provided

versionCodeinteger

Version code — required only if appVersionId is not provided

curl -i -X POST \
  http://127.0.0.1:40000/api/cloudphone/app/install \
  -H 'Content-Type: application/json' \
  -d '{
    "appVersionId": "1672940217990530",
    "id": "1673823102599682"
  }'

Responses

Success. data is a single boolean value.

Headers
any
Bodyapplication/json
codeinteger
msgstring or null
databoolean
requestIdstring
Response
{
  "code": 0,
  "msg": null,
  "data": true,
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"
}