# Cloud Phone API Capability Catalog Integrate Android Cloud Phone creation, day-to-day operations, app distribution, file transfer, and backups into your own business system through APIs. ## Capabilities at a glance | Module | What you can do | | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | [Cloud Phone Management](#cloud-phone-management) | Manage Cloud Phones from creation and daily operation to recycling, and adjust device and network settings. | | [Image Management](#image-management) | View available system Images and device models, and use them to create Cloud Phones. | | [Task Management](#task-management) | Track Cloud Phone operations, view the result for each device, and investigate unexpected outcomes. | | [App Management](#app-management) | Find apps, distribute installation packages, and manage apps and accessibility services on Cloud Phones. | | [File Management](#file-management) | Manage cloud files for the current Cloud Card, and transfer files or media to Cloud Phones. | | [Backup Management](#backup-management) | Export Cloud Phones as Backups, manage Backup files, and create new Cloud Phones from existing Backups. | ## Contents - [Cloud Phone Management](#cloud-phone-management) - [Image Management](#image-management) - [Task Management](#task-management) - [App Management](#app-management) - [File Management](#file-management) - [Backup Management](#backup-management) - [Supporting capabilities](#supporting-capabilities) - [Getting started](#getting-started) - [Technical reference](#technical-reference) Available operations depend on the devices and delivery environment. After submitting a device operation, check the task and each device result; acceptance does not mean execution is complete. ## Cloud Phone Management Manage Cloud Phones from creation and daily operation to recycling, and adjust device and network settings. | Capability | What it does | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | List Cloud Phones | Find Cloud Phones by name, group, status, and other filters, with paginated results. | | View Cloud Phone Details | View basic information, associated resources, and the most recently synchronized status of a Cloud Phone. | | View Cloud Phone Statistics | Summarize Cloud Phone counts, power states, and the number available for operation. Operational availability requires both power and network availability. The last synchronized status does not guarantee that a phone can be connected to or streamed right now. | | Create Cloud Phones | Create one or more Cloud Phones on selected Cloud Cards using existing Images and device models. | | Power On | Start selected Cloud Phones, including multiple devices in one operation. | | Power Off | Shut down selected Cloud Phones, including multiple devices in one operation. | | Restart | Restart selected Cloud Phones. | | Rename a Cloud Phone | Give a Cloud Phone a name that is easy to identify in your business. | | Manage Cloud Phone Groups | View existing groups and change which group a Cloud Phone belongs to. | | Recycle Cloud Phones | Move Cloud Phones that are temporarily unused to the recycle bin. | | Restore Recycled Cloud Phones | Return Cloud Phones from the recycle bin to use. This restores the original Cloud Phone from the recycle bin. To create a new Cloud Phone from a Backup, see Backup Management. | | Permanently Delete Cloud Phones | Permanently remove Cloud Phones that are no longer needed. | | Repair Cloud Phones | Request a repair operation for Cloud Phones with a problem. Repair does not automatically power the phone on or off, or perform a factory reset. Confirm afterward whether the device has returned to normal. | | Factory Reset | Clear apps and data from Cloud Phones while keeping their basic hardware identifiers. | | Reset as New Device | Clear apps and data, and regenerate basic configuration and hardware identifiers. | | Check Available Operations | Find which operations a Cloud Phone supports and whether it currently meets their execution conditions. | | View Internal Network Addresses | View the most recently read internal network addresses to help with connectivity and network troubleshooting. | | View Current Configuration | View the most recently read resolution, proxy, and DNS settings of a Cloud Phone. | | Set Resolution | Adjust the Cloud Phone display size or restore the device default resolution. | | Set Screen Orientation | Set a Cloud Phone to landscape, portrait, or reverse orientation. | | View Device Profiles | View adjustable device profile fields and masked current values. | | Update Device Profiles | Adjust supported device identity profiles using specified values or random generation. | | Manage Saved Configuration | View or change saved system, network, location, and device identity settings. Saving configuration does not automatically restart a Cloud Phone or mean that a running device has adopted the new values. | | Set Network Proxy | Save proxy settings for a Cloud Phone or select a direct connection. | | Check Proxy Egress | Check the Machine Room internet egress through a specified proxy or direct connection. The result describes the Machine Room egress; it does not prove that the Cloud Phone has adopted those proxy settings. | | Set DNS | Save DNS server settings for a Cloud Phone. | | Simulate Incoming SMS | Inject a simulated SMS with a specified sender and message into a Cloud Phone. This simulates incoming messages. It does not provide a real phone number, an SMS sending or receiving service, or a verification-code channel. | ## Image Management View available system Images and device models, and use them to create Cloud Phones. The current scope covers finding and selecting existing Images; it does not include Image uploads, creation, version publishing, or distribution management. Image and model lists reflect the most recently synchronized options. Actual conditions are checked again when creating a Cloud Phone. | Capability | What it does | | ------------------------------- | ---------------------------------------------------------------------------------- | | List Available Images | View the system Image options currently offered by a specified Cloud Card. | | View Compatible Device Models | View available device models and the Images each model allows. | | Create Cloud Phones from Images | Choose an existing Image and a compatible device model to create new Cloud Phones. | ## Task Management Track Cloud Phone operations, view the result for each device, and investigate unexpected outcomes. Task management tracks submitted device operations; it does not provide scheduled execution or multistep automation workflows. | Capability | What it does | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Check Operation Conditions | Check permissions and current execution conditions for the selected devices before submitting an operation. | | Submit Single or Batch Operations | Submit operations for selected devices as Tasks that can be queried over time. | | View Progress and Results | Query Task progress and view success, failure, or unconfirmed results for each device. | | View Task History | Browse previously submitted operations, their targets, and their results with pagination. | | Request Task Cancellation | Cancel operations that have not been dispatched, and record cancellation requests for those already dispatched. An operation already sent to a device is not guaranteed to stop. Query the original Task to confirm its result. | | Find an Original Submission | Use the original request identifier to find an accepted Task when a submission did not receive a clear response. | | Verify Operations with Unknown Results | Query the original operation or files already generated to complete the Task result. This checks the original operation; it does not execute the same device operation again. | ## App Management Find apps, distribute installation packages, and manage apps and accessibility services on Cloud Phones. | Capability | What it does | | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | List Installed Apps | View apps already installed on a Cloud Phone. | | Browse Available Apps | Browse the installable app catalog provided by the delivery environment. The delivery provider configures the app catalog. Installation from packages or links remains available when no catalog is configured. | | Install Uploaded Apps | Install completed uploads from the cloud file library onto selected Cloud Phones. | | Install Apps from Links | Download an installation package from a link and install it onto selected Cloud Phones. | | Start Apps | Start specified installed apps on Cloud Phones. | | Stop Apps | Stop specified apps running on Cloud Phones. | | Restart Apps | Restart specified apps on Cloud Phones. | | Uninstall Apps | Remove specified apps from selected Cloud Phones. | | List App Accessibility Services | View the accessibility services provided by an app and their status. | | Configure App Accessibility Services | Enable or disable specified app accessibility services. | | Open App Accessibility Entry | Open the accessibility entry for a specified app. | | Hide App Accessibility Entry | Hide the accessibility entry for a specified app. Hiding an accessibility entry does not hide the app itself. | ## File Management Manage cloud files for the current Cloud Card, and transfer files or media to Cloud Phones. A completed upload means the file has been saved in cloud storage. Installing an app or sending a file to a phone requires a separate operation. The cloud file library belongs to the current Cloud Card; it is not shared across Cloud Cards. The current API does not provide full browsing, retrieval, or moving of files inside a phone. | Capability | What it does | | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | Upload Files | Upload installation packages, images, videos, and other files to the current Cloud Card file library, with multipart transfer and integrity checking. | | List Cloud Files | Browse files in the current Cloud Card file library with pagination and filters by name or type. | | View File Status | View a cloud file and check whether its upload is complete and the file is ready to use. | | Download Cloud Files | Download ready cloud files or generate download links with an expiry time. | | Delete Cloud Files | Delete files that are no longer needed from the current file library. | | Send Uploaded Files to Phones | Send files from the cloud file library to category directories on Cloud Phones, such as downloads, pictures, or videos. | | Send Files from Links | Download files from links and send them to specified category directories on Cloud Phones. | | Capture Cloud Phone Screenshots | Capture a Cloud Phone screen and retrieve the image as a cloud file. | ## Backup Management Export Cloud Phones as Backups, manage Backup files, and create new Cloud Phones from existing Backups. The current scope provides on-demand Backup and restore. It does not include automatic Backup policies or scheduled retention management. Backup contents and restore compatibility must be confirmed at delivery. | Capability | What it does | | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Check Backup Availability | Check whether a Cloud Phone currently supports Backup and meets the relevant execution conditions. | | Create Backups | Request a Backup export for selected Cloud Phones and deliver the generated files to cloud storage. | | View Backup History | Browse generated and fully delivered Backups with pagination. Check the original Task for the progress of a Backup export that is still in progress. | | Download Backups | Obtain download links with an expiry time for ready Backups. | | Delete Backups | Delete Backup files that are no longer needed. | | Create Cloud Phones from Backups | Import an existing usable Backup into a specified Cloud Card to create a new Cloud Phone. Restore creates a new Cloud Phone and keeps the original. Access to both the Backup and target Cloud Card is required. Compatibility across Machine Rooms must be confirmed at delivery. | ## Supporting capabilities ### Screen Streaming and Preview Add Cloud Phone viewing, interaction, and camera media settings to your business pages. | Capability | What it does | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Stream and Control Cloud Phones | Obtain a screen streaming connection so authorized users can view and operate a Cloud Phone. Current screen streaming connections include device control and require the corresponding operation permission. | | View Read-Only Previews | Obtain short-lived read-only screen previews for multiple Cloud Phones. Previews do not provide device control. A picture is not guaranteed when a phone is offline or powered off. | | Set Camera Images | Set the camera background image on a Cloud Phone using an uploaded file or image link. | | Set Camera Media | Replace a specified camera feed with supported image or video media. After applying the setting, confirm the actual camera picture on the Cloud Phone. | ### Cloud Card and Machine Room Resources View the Cloud Cards that host Cloud Phones and their Machine Rooms to plan creation and maintenance. | Capability | What it does | | -------------------------- | ---------------------------------------------------------------------- | | List Cloud Cards | View accessible Cloud Card resources and filter the results. | | View Cloud Card Details | View information about a Cloud Card and which resources it belongs to. | | View Cloud Card Statistics | Summarize Cloud Card counts and status within the current scope. | | View Machine Rooms | View the names and online status of visible Machine Rooms. | ### Access Authorization Connect device scope, operation permissions, and access duration to your own business login system. Revoking API access does not guarantee that an established screen streaming connection closes immediately. Existing streaming tickets expire at their specified time. | Capability | What it does | | --------------------------------- | -------------------------------------------------------------------------------------------------------- | | Grant Restricted Access | Issue access for business users with a limited device scope, operation permissions, and validity period. | | Update Access Authorization | Update the device scope, permissions, or validity period of existing user access. | | Find Business Login Authorization | Find the access authorization associated with a login record in your own business system. | | Revoke Specific Access | Revoke an access authorization to prevent further API requests with it. | | Revoke Business Login Access | Revoke access associated with a business login record for sign-out or account disabling. | ## Getting started Connect your business system to the Core API, or manage Cloud Phones through the Web Base standard workbench. 1. Use the modules in this catalog to confirm your business needs, paying particular attention to the scope of Images, files, and Backups. 2. Once the scope of cooperation is agreed, have your technical team connect the service endpoint, access authorization, target devices, and asynchronous task results. 3. Complete integration testing through your own business pages or the standard workbench, then validate against the actual devices and delivery environment. ## Technical reference For integration details, your technical team can read the [English API reference](openapi.en.md), the [English OpenAPI reading view](openapi.en.json), and the [original OpenAPI contract](openapi.json) for request methods, parameters, and responses.