Updated on 2025-10-30 GMT+08:00

API Overview

Table 1 describes the KooPhone APIs.

Table 1 KooPhone APIs

Type

Description

Executing a Synchronization Command

Specify a cloud phone instance to synchronously execute Android Debug Bridge (adb) shell commands.

Executing an Asynchronization Command

Specify a cloud phone instance to asynchronously execute adb shell commands.

Querying Instance Execution Tasks

Query the execution result after an adb shell command is asynchronously executed.

Instance Video Settings

Set the bit rate and output frame rate corresponding to each definition of an instance.

Querying Instance Status in Batches

Query the status of cloud phone instances.

Resetting Instances in Batches

Reset cloud phone instances.

Obtaining device_token Before Streaming

Obtain device_token of a cloud phone instance as the authentication information and carry device_id of the cloud phone instance to call the signaling address (signaling_url) in reverse parameters.

Assigning Instances

Allocate a cloud phone to a specified user of a tenant.

Canceling Instance Assignment

Cancel the assignment of a cloud phone to a specified user of a tenant and clear the usage data of the cloud phone.

Querying Instances in Batches

Query information about all instances under a tenant in batches.

Restarting Instances

Restart cloud phone instances in batches.

Querying Saleable Instance SKUs in Batches

Query the specifications of all available instances under a tenant.

Provisioning an Instance API

Create instances.

Deleting Instances

Cancel yearly/monthly subscriptions (pay-per-use subscriptions cannot be canceled).

Preparing Instances in Batches

Prepare the current instance for streaming.

Instance Preparation Progress

Call this API cyclically until the cloud phone status is normal, and then enable streaming.

Backing Up an Instance

Back up instance data to OBS in batches and then release physical instances.

Stopping Streaming of an Instance

Stop streaming of an instance. This indicates that this API takes effect on instances in streaming.

Releasing a Session by an Instance

Release sessions after the streaming stops.

Installing an App on an Instance

Install applications to cloud phone instances in batches.