Skip to content

OpenAPI Reference ​

The OpenAPI provides standard HTTP endpoints for managing cloud phone instances, tasks, and related resources.

API List ​

App Management ​

APIMethodPathDescription
Batch Delete AppsPOST/papi/application/batch/deleteBatch delete apps
Delete AppPOST/papi/application/deleteDelete an app
Get App TagsPOST/papi/application/getAppTagsGet app tags
Get Installed AppsPOST/papi/application/getInstallAppListGet installed apps on cloud phone
Get Market App PagePOST/papi/application/getApplicationPageGet market app page
Get Preinstall QuotaPOST/papi/application/getPreInstallCountGet preinstall app quota
Update Preinstall StatusPOST/papi/application/updatePreinstalledFlagUpdate preinstall status
Get Team App PagePOST/papi/application/getTeamApplicationPageGet team app page

Cloud Machine ​

APIMethodPathDescription
Batch Extend ADBPOST/papi/container/extendAdbExpireBatch extend ADB expiration
Disable ADBPOST/papi/container/closeOpenAdbDisable ADB switch
Enable ADBPOST/papi/container/updateOpenAdbEnable ADB switch
Get ADB AccountPOST/papi/container/getAdbAccountListGet ADB account
Get All Cloud PhonesPOST/papi/container/all-containerGet all cloud phone list
Get Brand ModelsPOST/papi/container/modelGet brand models
Get Cloud Phone by AliasPOST/papi/container/getContainerGet cloud phone info by alias
Get Group Control ListPOST/papi/container/containerListGet group control list
Get Group TreePOST/papi/container/group-treeGet cloud phone group tree
Get Cloud Phone PagePOST/papi/container/pageGet cloud phone page
Wallet - Get Cloud InfoPOST/papi/container/getCloudInfoGet cloud phone info for wallet
Update Cloud Phone NamePOST/papi/container/updateContainerUpdate cloud phone name

Cloud Machine Operations ​

APIMethodPathDescription
Batch Change ModelPOST/papi/container/operate/batch/changeModelBatch change model
Batch Close AppPOST/papi/container/operate/stopAppBatch close apps
Batch Disable ProxyPOST/papi/container/operate/batch/stopProxyBatch disable proxy
Batch Get Connect ConfigPOST/papi/container/operate/batch/getConnectConfigBatch get connect config
Batch Get ScreenshotPOST/papi/container/operate/batch/screenRealBatch get screenshots
Batch Get StatusPOST/papi/container/operate/batch/getInstanceStatusBatch get instance status
Batch Get ThumbnailPOST/papi/container/operate/batch/screenshotBatch get thumbnails
Batch Input ClipboardPOST/papi/container/operate/batch/inputCommitTextBatch input clipboard content
Batch Install AppPOST/papi/container/operate/install-pkgBatch install app
Batch Install Apps (Async)POST/papi/container/operate/batch/async/installPkgBatch install apps asynchronously
Batch Launch AppPOST/papi/container/operate/startAppBatch launch apps
Batch RebootPOST/papi/container/operate/batch/restartBatch reboot cloud phones
Batch ResetPOST/papi/container/operate/batch/resetBatch reset cloud phones
Batch Restart AppPOST/papi/container/operate/batch/restartAppBatch restart apps
Batch Set ResolutionPOST/papi/container/operate/setDisplayBatch set resolution
Batch Set RootPOST/papi/container/operate/batch/setRootAppBatch set root permission for apps
Batch Uninstall AppPOST/papi/container/operate/uninstallAppBatch uninstall app
Batch Uninstall AppsPOST/papi/container/operate/batch/uninstallAppsBatch uninstall apps
ConnectPOST/papi/container/operate/getConnectConfigConnect to cloud phone
Disable ProxyPOST/papi/container/operate/stopProxyDisable proxy
Download FilePOST/papi/container/operate/fileDownLoadDownload file from cloud phone
Get ConfigPOST/papi/container/operate/getContainerInfoGet cloud phone config
Get LocationPOST/papi/container/operate/getPositioningInfoGet cloud phone location
Get ProxyPOST/papi/container/operate/getConfigureProxyGet proxy info
Get ScreenshotPOST/papi/container/operate/getScreenRealGet screenshot
Get StatusPOST/papi/container/operate/getInstanceStatusGet instance status
Multi Close AppsPOST/papi/container/operate/batch/stopAppMulti close apps
Multi Launch AppsPOST/papi/container/operate/batch/startAppMulti launch apps
Multi Restart AppsPOST/papi/container/operate/batch/batch-restartAppMulti restart apps
RebootPOST/papi/container/operate/restartContainerReboot cloud phone
Quick NewPOST/papi/container/operate/batch/quickNewQuick new device
ResetPOST/papi/container/operate/resetContainerReset cloud phone
Set ProxyPOST/papi/container/operate/startProxySet proxy
Execute ShellPOST/papi/container/operate/executeShellExecute shell command
Update ConfigPOST/papi/container/operate/startGpsUpdate cloud phone config
Upload Qrcode ImagePOST/papi/container/operate/uploadQrcodeImageUpload Qrcode Image

Fault Reporting ​

APIMethodPathDescription
Create Fault ReportPOST/papi/fault-reports/createSubmit a cloud phone fault ticket

File Management ​

APIMethodPathDescription
Batch Delete FilesPOST/papi/file/batch/deleteBatch delete files
Batch Push Files (Async)POST/papi/file/asyncUploadContainersFilesAsync push files to multiple cloud phones
Batch Push FilesPOST/papi/file/uploadContainersFilesPush files to multiple cloud phones
Cancel UploadPOST/papi/file/upload/cancelCancel file upload
Delete FilePOST/papi/file/deleteDelete file
Get Disk InfoPOST/papi/file/cloudDiskGet cloud disk info
File PagePOST/papi/file/pageFile page
Over Capacity PagePOST/papi/file/overCapacityPageOver capacity file page
Pre-uploadPOST/papi/file/upload/preUploadPre-upload file chunks
Push File to Cloud PhonePOST/papi/file/uploadContainerFilePush file to cloud phone
Upload AttachmentPOST/papi/file/uploadAttachmentUpload attachment
Upload FilePOST/papi/file/upload/chunkUpload file to system

Operation Logs ​

APIMethodPathDescription
API Access Log PagePOST/papi/zw/log/api-access/pageGet API access log page
Operation Log PagePOST/papi/zw/log/operate/pageGet operation log page

Payment Orders ​

APIMethodPathDescription
Cancel OrderPOST/papi/order/cancelCancel order
Cloud Disk All Plan ListPOST/papi/product/cloudDeviceAllPackageListGet all cloud disk plans
Cloud Disk Plan ListPOST/papi/product/cloudDevicePackageListGet cloud disk plan list
Cloud Disk Sku ListPOST/papi/product/cloudDeviceSkuListGet cloud disk SKU list
Cloud Phone All Plan ListPOST/papi/product/containerAllPackageListGet all cloud phone plans
Cloud Phone Plan ListPOST/papi/product/containerPackageListGet cloud phone plan list
Cloud Phone Sku ListPOST/papi/product/containerSkuListGet cloud phone SKU list
Confirm PaymentPOST/papi/order/checkChannelPayStatusConfirm order payment
Cloud Disk Renewal OrderPOST/papi/order/cloudDisk/renewal/createCreate cloud disk renewal order
Get Order DetailsPOST/papi/order/detailsGet order details
Get Pay Order DetailsGET/papi/order/getPayOrderGet pay order details
Get RegionsPOST/papi/pay/area/listGet payment region list
InventoryPOST/papi/product/containerStockQuery cloud phone inventory
Static IP Renewal OrderPOST/papi/order/ip/renewal/createCreate a static IP renewal order
Order DetailPOST/papi/order/getOrderDetailGet order detail
Order PagePOST/papi/order/pagePayment order page
PayPOST/papi/order/orderPayOrder payment
Payment MethodsPOST/papi/pay/payWayListGet payment methods
Place OrderPOST/papi/order/createPlace order
Price CalculationPOST/papi/product/price-calcProduct price calculation
Purchase DataGET/papi/product/containerBuyDataGet cloud phone purchase data
Renewal OrderPOST/papi/order/renewal/createCreate cloud phone renewal order
Renewal PricePOST/papi/order/renewal/price-calcCloud phone renewal price calculation
SKU App ListGET/papi/sku-adapt-app/listGet SKU compatible app list
Verify Payment MethodPOST/papi/order/check-paymentVerify or regenerate payment method

Task Management ​

APIMethodPathDescription
Task PagePOST/papi/zw/task/pageGet container operation task page
Task List by UUIDPOST/papi/zw/task/listGet task list by UUID list
Subtask DetailPOST/papi/zw/subtask/detailListGet subtask detail by UUID list
Subtask List by Task UUIDPOST/papi/zw/subtask/listByTaskIdGet subtask list by task UUID list
Subtask ListPOST/papi/zw/subtask/listGet subtask list by task UUID
Subtask PagePOST/papi/zw/subtask/pageGet subtask page

Wallet Management ​

APIMethodPathDescription
Auto-Renewal Policy PagePOST/papi/wallet/auto-renew/pagePaginated query of auto-renewal policies by resource type
Auto-Renewal Task PagePOST/papi/wallet/auto-renew/task/pagePaginated query of auto-renewal task records
Update Auto-Renewal SwitchPOST/papi/wallet/auto-renew/updateEnable or disable resource auto-renewal
Create Wallet RechargePOST/papi/wallet/recharge/createCreate a wallet recharge order
Get Wallet BalancePOST/papi/wallet/balanceQuery wallet balance and recharge/debit statistics
Get Recharge StatusPOST/papi/wallet/recharge/getQuery recharge crediting status by order number
Recharge Transaction PagePOST/papi/wallet/recharge/pagePaginated query of credited recharge transactions
Fund Transaction PagePOST/papi/wallet/transaction/pagePaginated query of all fund transactions

OpenAPI Docs