VMOSCloud OpenAPI Developer Quick Reference
VMOSCloud cloud phone OpenAPI quick reference · Suitable for AI tools to read directly
This page is an AI quick reference for LLMs and code assistants to parse API paths, methods, and purposes. For detailed request/response parameters and examples, see API Documentation.
📥 Download plain text version — Suitable for AI tools to read directly
How to get it:
- Browser download: Click here to download llms-ai-reference.txt, or open
https://your-docs-domain/vmoscloud/doc/en/server/llms-ai-reference.txt(if the browser opens the file instead of downloading, right‑click the link and choose “Save link as”). - Command line:
curl https://your-docs-domain/vmoscloud/doc/en/server/llms-ai-reference.txt -o vmoscloud-api.txt - Online preview: Open the URL above in a browser to view the raw text (set encoding to UTF-8 if you see garbled characters).
Other options: This page is in Markdown for parsing; for full API parameters and examples see API Documentation, for authentication and signing see Getting Started.
🔐 Authentication (required)
Authentication
This API uses HMAC-SHA256 signature verification.
Request headers (required for every request)
| Header | Description | Example |
|---|---|---|
| x-date | Request UTC time, ISO 8601 format | 20240301T093700Z |
| x-host | API host | api.vmoscloud.com |
| Content-Type | Resource MIME type | application/json |
| authorization | HMAC-SHA256 signature | See Getting Started |
Authorization format
HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}
Signature steps (canonical request, string-to-sign, SigningKey, Signature) and sample code: Getting Started - Authorization.
📡 Base information
| Item | Value |
|---|---|
| Base URL | https://api.vmoscloud.com |
| Path prefix | /vcpcloud/api/padApi/ (most APIs) |
| Response format | JSON { code, msg, ts, data } |
| Success code | code=200 |
📚 API by category
1️⃣ Instance Management
| API | Method | Path | Description |
|---|---|---|---|
| Modify instance WIFI properties | POST | /vcpcloud/api/padApi/setWifiList | Modify WIFI list properties of specified instance |
| Instance details | POST | /vcpcloud/api/padApi/padDetails | Query instance properties (pending) |
| Instance restart | POST | /vcpcloud/api/padApi/restart | Restart specified instance |
| Instance reset | POST | /vcpcloud/api/padApi/reset | Clear all cloud instance data |
| Query instance properties | POST | /vcpcloud/api/padApi/padProperties | Query instance system/settings properties |
| Batch query instance properties | POST | /vcpcloud/api/padApi/batchPadProperties | Batch query instance properties |
| Modify instance properties | POST | /vcpcloud/api/padApi/updatePadProperties | Dynamically modify instance properties |
| Modify instance Android modification props | POST | /vcpcloud/api/padApi/updatePadAndroidProp | Static modification props, restart required |
| Modify SIM by country code | POST | /vcpcloud/api/padApi/updateSIM | Random SIM by country and restart |
| Stop streaming | POST | /vcpcloud/api/padApi/dissolveRoom | Stop streaming for specified instance |
| Smart IP proxy detection | POST | /vcpcloud/api/padApi/checkIP | Detect proxy IP and location |
| Set smart IP | POST | /vcpcloud/api/padApi/smartIp | Set smart IP (exit IP, SIM, GPS, etc.) |
| Cancel smart IP | POST | /vcpcloud/api/padApi/notSmartIp | Cancel smart IP |
| Device task result query | POST | /vcpcloud/api/padApi/getTaskStatus | Query smart IP task result |
| Get installed apps for specified instances | POST | /vcpcloud/api/padApi/getListInstalledApp | Get installed app info for specified instances |
| Modify instance timezone | POST | /vcpcloud/api/padApi/updateTimeZone | Modify instance timezone |
| Modify instance language | POST | /vcpcloud/api/padApi/updateLanguage | Modify instance language |
| Set instance GPS | POST | /vcpcloud/api/padApi/gpsInjectInfo | Set instance latitude/longitude |
| Query instance proxy info | POST | /vcpcloud/open/network/proxy/info | Query instance proxy info (pending) |
| One-key new device | POST | /vcpcloud/api/padApi/replacePad | Clear data and reset Android properties |
| Query one-key new device supported countries | GET | /vcpcloud/api/padApi/country | One-key new device supported countries |
| Update contacts | POST | /vcpcloud/api/padApi/updateContacts | Update contacts |
| Set instance proxy | POST | /vcpcloud/api/padApi/setProxy | Set proxy for specified instance |
| Real-time query installed app list | POST | /vcpcloud/api/padApi/listInstalledApp | Real-time query installed apps |
| Set app keep-alive | POST | /vcpcloud/api/padApi/setKeepAliveApp | Set app keep-alive (Android 13/14/15) |
| Set app hide | POST | /vcpcloud/api/padApi/setHideAppList | Send hide package list (pending) |
| Modify real device ADI template | POST | /vcpcloud/api/padApi/replaceRealAdiTemplate | Modify cloud real device ADI template |
| Async execute ADB command | POST | /vcpcloud/api/padApi/asyncCmd | Async execute command |
| Switch Root permission | POST | /vcpcloud/api/padApi/switchRoot | Switch root permission |
| Local screenshot | POST | /vcpcloud/api/padApi/screenshot | Instance screenshot |
| Get instance real-time preview image | POST | /vcpcloud/api/padApi/getLongGenerateUrl | Get real-time preview image URL |
| Upgrade image | POST | /vcpcloud/api/padApi/upgradeImage | Batch instance image upgrade |
| Upgrade real device image | POST | /vcpcloud/api/padApi/virtualRealSwitch | Batch real device image upgrade |
| Paginated get real device templates | POST | /vcpcloud/api/padApi/templateList | Paginated get real device templates |
| Batch get instance model info | POST | /vcpcloud/api/padApi/modelInfo | Batch get model info (pending) |
| Set instance bandwidth | POST | /vcpcloud/api/padApi/setSpeed | Set instance bandwidth (pending) |
| Enable/disable ADB | POST | /vcpcloud/api/padApi/openOnlineAdb | Enable or disable instance ADB |
| Get ADB connection info | POST | /vcpcloud/api/padApi/adb | Get ADB connection info |
| Batch get ADB connection info | POST | /vcpcloud/api/padApi/batch/adb | Batch get/disable ADB (pending) |
| Simulate touch | POST | /vcpcloud/api/padApi/simulateTouch | Simulate touch event |
| Instance operation task details | POST | /vcpcloud/api/padApi/padTaskDetail | Query instance operation task result |
| Get instance script execution result | POST | /vcpcloud/api/padApi/executeScriptInfo | Get script execution result (pending) |
| Get instance screenshot result | POST | /vcpcloud/api/padApi/screenshotInfo | Get screenshot result by task ID (pending) |
| Instance restart/reset execution result | POST | /vcpcloud/api/padApi/padExecuteTaskInfo | Restart/reset task result (pending) |
| Instance group list | POST | /vcpcloud/api/padApi/infos | Instance group list (infos also used for instance list) |
| Import call records | POST | /vcpcloud/api/padApi/addPhoneRecord | Import call records |
| Cloud phone text input | POST | /vcpcloud/api/padApi/inputText | Input text in focused input box |
| Simulate send SMS | POST | /vcpcloud/api/padApi/simulateSendSms | Simulate sending SMS to instance |
| Reset GAID | POST | /vcpcloud/api/padApi/resetGAID | Reset advertising ID |
| Inject audio to instance microphone | POST | /vcpcloud/api/padApi/injectAudioToMic | Inject audio to microphone |
| Create local instance backup | POST | /vcpcloud/api/padApi/localPodBackup | Create local backup (pending) |
| Create local instance restore | POST | /vcpcloud/api/padApi/localPodRestore | Local backup restore (pending) |
| Local instance backup result query | POST | /vcpcloud/api/padApi/localPodBackupSelectPage | Query local available backups (pending) |
| Clear processes and return to desktop | POST | /vcpcloud/api/padApi/cleanAppHome | Clear processes and return to desktop (pending) |
| Unmanned live streaming | POST | /vcpcloud/api/padApi/unmannedLive | Instance video injection |
| Image injection | POST | /vcpcloud/api/padApi/injectPicture | Instance image injection (pending) |
| Upload user image | POST | /vcpcloud/api/padApi/addUserRom | Upload user image |
| Device replacement | POST | /vcpcloud/api/padApi/replacement | Device replacement |
| Transfer cloud phone | POST | /vcpcloud/api/padApi/confirmTransfer | Transfer cloud phone to another account |
| Hide accessibility service | POST | /vcpcloud/api/padApi/setHideAccessibilityAppList | Hide accessibility service |
2️⃣ Resource Management
| API | Method | Path | Description |
|---|---|---|---|
| Instance list info | POST | /vcpcloud/api/padApi/infos | Paginated query ordered instance list |
3️⃣ Application Management
| API | Method | Path | Description |
|---|---|---|---|
| Uninstall app | POST | /vcpcloud/api/padApi/uninstallApp | Uninstall by instance and package name |
| Start app | POST | /vcpcloud/api/padApi/startApp | Start app by instance and package name |
| Stop app | POST | /vcpcloud/api/padApi/stopApp | Stop app |
| Restart app | POST | /vcpcloud/api/padApi/restartApp | Restart app |
| Instance installed app list query | POST | /vcpcloud/api/padApi/listInstalledApp | Query instance installed apps |
| Upload file via URL | POST | /vcpcloud/api/padApi/uploadFileV3 | Upload via URL with optional install |
| Upload file to cloud storage | POST | /vcpcloud/api/padApi/uploadFile | Upload file to cloud storage |
| Delete cloud storage files | POST | /vcpcloud/api/padApi/deleteOssFiles | Delete cloud storage files |
| Query user file list | POST | /vcpcloud/api/padApi/selectFiles | Query user file list |
4️⃣ Task Management
| API | Method | Path | Description |
|---|---|---|---|
| Instance operation task details | POST | /vcpcloud/api/padApi/padTaskDetail | Query instance operation task execution result |
| File task details | POST | /vcpcloud/api/padApi/fileTaskDetail | Query file task execution result |
5️⃣ Cloud Phone Management
| API | Method | Path | Description |
|---|---|---|---|
| Create/renew cloud phone | POST | /vcpcloud/api/padApi/createMoneyOrder | Create or renew cloud phone |
| Cloud phone list | POST | /vcpcloud/api/padApi/userPadList | Cloud phone list |
| Cloud phone info query | POST | /vcpcloud/api/padApi/padInfo | Cloud phone info query |
| SKU package list | GET | /vcpcloud/api/padApi/getCloudGoodList | SKU package list |
| Device presale purchase | POST | /vcpcloud/api/padApi/createMoneyProOrder | Device presale purchase |
| Query presale order result details | POST | /vcpcloud/api/padApi/queryProOrderList | Presale order details |
| Android image version list | POST | /vcpcloud/api/padApi/imageVersionList | Upgradable image list |
| Create timing device order | POST | /vcpcloud/api/padApi/createByTimingOrder | Create timing device order |
| Timing device power on | POST | /vcpcloud/api/padApi/timingPadOn | Timing device power on |
| Timing device power off | POST | /vcpcloud/api/padApi/timingPadOff | Timing device power off |
| Timing device destroy | POST | /vcpcloud/api/padApi/timingPadDel | Timing device destroy |
| Storage resource package list | GET | /vcpcloud/api/padApi/vcTimingBackupList | Storage resource package list |
| Cloud storage remaining capacity | GET | /vcpcloud/api/padApi/getRenewStorageInfo | Cloud storage remaining capacity |
| Cloud storage product list | GET | /vcpcloud/api/padApi/getVcStorageGoods | Cloud storage product list |
| Purchase cloud storage expansion | POST | /vcpcloud/api/padApi/buyStorageGoods | Purchase cloud storage expansion |
| Cloud storage renewal details query | GET | /vcpcloud/api/padApi/selectAutoRenew | Cloud storage renewal details |
| Aggregate renew cloud storage products | POST | /vcpcloud/api/padApi/renewsStorageGoods | Aggregate renew cloud storage products |
| Cloud storage auto-renewal switch | GET | /vcpcloud/api/padApi/updateRenewStorageStatus | Cloud storage auto-renewal switch |
| Delete backup resource package data | POST | /vcpcloud/api/padApi/deleteUploadFiles | Delete backup resource package |
| Show or hide app process | POST | /vcpcloud/api/padApi/toggleProcessHide | Show or hide app process |
6️⃣ Email Verification Service
| API | Method | Path | Description |
|---|---|---|---|
| Get email service list | GET | /vcpcloud/api/padApi/getEmailServiceList | Email service list |
| Get email type and remaining stock | GET | /vcpcloud/api/padApi/getEmailTypeList | Email type and stock |
| Create email order | POST | /vcpcloud/api/padApi/createEmailOrder | Create email order |
| Query purchased email list | GET | /vcpcloud/api/padApi/getEmailOrder | Purchased email list |
| Refresh get email verification code | GET | /vcpcloud/api/padApi/getEmailCode | Refresh get verification code |
7️⃣ Dynamic Proxy Service
| API | Method | Path | Description |
|---|---|---|---|
| Query dynamic proxy product list | GET | /vcpcloud/api/padApi/getDynamicGoodService | Dynamic proxy product list |
| Query dynamic proxy region list | GET | /vcpcloud/api/padApi/getDynamicProxyRegion | Dynamic proxy region list |
| Get dynamic proxy current balance | GET | /vcpcloud/api/padApi/queryCurrentTrafficBalance | Current traffic balance |
| Query supported server regions | GET | /vcpcloud/api/padApi/getDynamicProxyHost | Supported server regions |
| Purchase dynamic proxy traffic package | POST | /vcpcloud/api/padApi/buyDynamicProxy | Purchase dynamic proxy traffic package |
| Create dynamic proxy | POST | /vcpcloud/api/padApi/createProxy | Create dynamic proxy |
| Query dynamic proxy list (paginated) | GET | /vcpcloud/api/padApi/getProxys | Dynamic proxy list |
| Query dynamic proxy order list (paginated) | POST | /vcpcloud/api/padApi/getDynamicProxyOrders | Dynamic proxy order list |
| Configure dynamic proxy for instances | POST | /vcpcloud/api/padApi/batchPadConfigProxy | Configure dynamic proxy for instances |
| Query batch instance set proxy task | POST | /vcpcloud/api/padApi/selectBatchPadProxyTask | Batch set proxy task result |
| Query dynamic proxy auto-renewal info | GET | /vcpcloud/api/padApi/getDynamicProxyAutomaticRenewal | Auto-renewal info |
| Set dynamic proxy auto-renewal switch | POST | /vcpcloud/api/padApi/setAutoRenewSwitch | Auto-renewal switch |
| Delete dynamic proxy | POST | /vcpcloud/api/padApi/delProxyByIds | Delete dynamic proxy |
8️⃣ Static Residential Proxy Service
| API | Method | Path | Description |
|---|---|---|---|
| Get static residential product list | GET | /vcpcloud/api/padApi/proxyGoodList | Static residential product list |
| Get static residential supported countries/cities | GET | /vcpcloud/api/padApi/getProxyRegion | Country and city info |
| Static residential product purchase | POST | /vcpcloud/api/padApi/createProxyOrder | Static residential purchase |
| Static residential proxy order details | POST | /vcpcloud/api/padApi/selectProxyOrderList | Order details |
| Static residential proxy renewal | POST | /vcpcloud/api/padApi/createRenewProxyOrder | Static residential renewal |
| Query static residential proxy list | POST | /vcpcloud/api/padApi/queryProxyList | Static residential proxy list |
9️⃣ TK Automation
| API | Method | Path | Description |
|---|---|---|---|
| Automation task list query | POST | /vcpcloud/api/padApi/autoTaskList | Automation task list |
| Create automation task | POST | /vcpcloud/api/padApi/addAutoTask | Create automation task |
| Automation task retry | POST | /vcpcloud/api/padApi/reExecutionAutoTask | Automation task retry |
| Automation task cancel | POST | /vcpcloud/api/padApi/cancelAutoTask | Automation task cancel |
🔟 SDK Token
| API | Method | Path | Description |
|---|---|---|---|
| Get SDK temporary token by padCode | POST | /vcpcloud/api/padApi/stsTokenByPadCode | Issue SDK temporary token |
| Clear SDK authorization token | POST | /vcpcloud/api/padApi/clearStsToken | Clear SDK authorization token |
📋 Callback events
| Event | taskBusinessType | Description |
|---|---|---|
| Instance status callback | 999 | Instance run/connection status change |
| Instance restart task | 1000 | Restart result notification |
| Instance reset task | 1001 | Reset result notification |
| Async ADB task | 1002 | ADB command execution result |
| App install task | 1003 | App install result |
| App uninstall task | 1004 | App uninstall result |
| App stop task | 1005 | App stop result |
| App restart task | 1006 | App restart result |
| App start task | 1007 | App start result |
| Instance file upload task | 1009 | File upload result |
| Instance upgrade image task | 1012 | Upgrade image result |
| One-key new device | 1124 | One-key new device result |
| User image upload | 4001 | User image upload result |
Configure callback URL in the web console. For payload details see Callback.
🚦 Common error codes
| Code | Description | Suggestion |
|---|---|---|
| 200 | Success | - |
| 2031 | Invalid key | Check AK/SK |
| 2032 | Missing Authorization header | Add signature header |
| 2019 | Signature verification failed | Check Getting Started |
| 100000 | Invalid request parameters | Check parameters |
| 100003 | Missing Authorization header | Check headers |
| 100004 | Invalid signature | Check signature calculation |
| 100005 | Signature verification failed | Confirm signing method |
| 110028 | Instance not found | Check instance ID |
| 110013 | Instance not found | Check instance parameters |
| 110031 | Instance not ready | Wait for instance ready |
| 120008 | Token not owned by current user | Confirm token owner |
More error codes: Error Codes.
💡 Usage tips
Tips
- Auth security: Keep AK/SK secure, do not hardcode in client, rotate periodically.
- Async tasks: Restart, reset, install, upload, etc. are async; configure callback or poll task detail API for result.
- Batch limits: Batch APIs have limits (e.g. 200 instances); batch requests and handle failure list.
- Instance state: Some operations require instance online/ready; check instance state before calling.
- Modification props and restart: Modifying Android modification props, SIM, etc. requires restart; differs from “modify instance properties” (dynamic).
📖 Related docs
Info
| Document | Description |
|---|---|
| API Documentation | Full API reference, request/response parameters and examples |
| Getting Started | Authentication, signing, and examples |
| Error Codes | Error codes and solutions |
| Callback | Callback types and example JSON |
| Instance list | Instance list field reference |
| Android modification props | Modification property reference |
Document version: Quick reference
Content subject to API Documentation