Start Cloud Phone

API Reference

Start Cloud Phone

Request

Start a Cloud Phone.

Preconditions: the phone must currently be powered off. It is rejected when the SKU is delisted or under maintenance, when the phone is held by another member, while its proxy is still being checked, when the account is in arrears or the phone is deactivated, when a monthly term has expired, and when neither free minutes, a concurrency slot nor a positive balance is available. Some models additionally require the latest Windows client.
Effect: marks the phone as booting, claims it for the calling member, and reserves a concurrency slot or starts consuming time. The response reports which of the two was used.
Completion: accepted, not complete. Poll /cloudphone/info until envStatus is powered on; a failure surfaces there as errorCode and errorMsg. Members with a callback host configured also receive a webhook.
Retry: a concurrent second call is rejected outright rather than queued. After a timeout, read /cloudphone/info — do not resend.

Documented business errors: 33300, 33309, 33315, 33316, 33317, 33318, 33321, 33322, 33323, 33324, 33325, 33346, 33347, 33367, 33376, 33407. See Error Codes for what each code means. Any operation can additionally return the common codes.

Bodyapplication/jsonrequired

idstringrequired

headlessboolean

Display Cloud Phone Window. false:Display, true:Do not display, Default:true

disableMoneySavingModeboolean

Disable power saving mode, default:false

curl -i -X POST \
  http://127.0.0.1:40000/api/cloudphone/powerOn \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "1637226321190925"
  }'

Responses

Bodyapplication/json

codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstring or nullrequired

Error message

requestIdstringrequired

Operation Request ID

Response

{
  "code": 0,
  "msg": null,
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"
}