Menu

Cloud Phone List

Usage Instructions

Retrieve the list of cloud phones, supports pagination, with a maximum of 100 records per page.

Request Instructions

  • Method: POST
  • Endpoint: /api/v1/cloudPhone/list

Request Parameters

Parameter Type Required Description
image_id array No IDs
name string No Name
group_id string No Group ID, can be obtained from the cloud phone group list
remark string No Remark
ips array No IPs
link_status array No Status: 0 Not configured; 1 Powered on; 2 Powered off; 3 Expired; 4 Renewal overdue; 10 Powering on; 11 Configuring; 12 Configuration failed
proxy_id string No Proxy ID, can be obtained from the proxy list
share_status array No Sharing status: 0 No Configured; 1 Shared; 2 Not Shared
start_phone_type array No Startup mode: 1 Prioritize Subscription Startup; 2 Subscription Startup; 3 Temporary Startup
adb_status array No ADB: 0 Disabled; 1 Enabled
renewal_status array No Auto-Renewal: 0 No; 1 Yes
sort_by string No Sorting field. Options: name (Name); created_at (Create Time); expired_at (Expiry Time)
order string No Sorting order: asc for ascending, desc for descending
user_ids array No Connected member IDs,can be obtained from the connected member list
tag_ids array No Tag IDs,can be obtained from the tag list
region_id array No OS IDs,can be obtained from the cloud phone resource list
page int No Request page number, defaults to the first page if not provided
pagesize int No Number of items per page, defaults to 10 items/page if not provided

Request Example

json Copy
{
    "page": 1,
    "pagesize": 10,
    "link_status": ["0"],
    "tag_ids": ["xxx"],
    "group_id": "xxx",
    "share_status": ["1"],
    "region_id": ["xxx"],
    "adb_status": ["1"],
    "sort_by": "created_at",
    "order": "desc",
    "image_id": ["xxx"],
    "ips": ["xxx"],
    "name": "xxx",
    "start_phone_type": ["1"],
    "renewal_status": ["0"],
    "remark": "xxx",
    "user_ids": ["xxx"],
    "proxy_id": "xxx"
}

Response Example

json Copy
{
    "code": 200,
    "data": {
        "list": [
            {
                "id": "xx", // Cloud phone ID
                "name": "xx", // Cloud phone name
                "status": 1, // Status: 0 Not configured; 1 Powered on; 2 Powered off; 3 Expired; 4 Renewal overdue; 10 Powering on; 11 Configuring; 12 Configuration failed
                "os": "Android 12", // Operating system
                "size": "30.08G", // Size
                "created_at": "2024-04-10 19:14:56",
                "expired_at": "2024-06-10 19:14:56",
                "ip": "xx",
                "area": "xx",
                "remark": "xx",
                "adb": "127.0.0.1:20100",
                "adb_password": ""
            }
        ],
        "page": 1,
        "pagesize": 10,
        "total": 1,
        "total_page": 1
    },
    "message": "Success"
}
Previous
Cloud Phone
Next
Batch Power On
Last modified: 2025-11-26Powered by