Get Cloud Phone List
FreshList Cloud Phones
URL: https://openapi.geelark.com/open/v1/phone/listMethod: POST
Pagination Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| page | No | integer | Page number (min 1) |
| pageSize | No | integer | Records per page (1-100) |
Query Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| ids | No | array[string] | Cloud phone IDs (max 100, overrides pagination) |
| serialName | No | string | Cloud phone name filter |
| remark | No | string | Remark filter |
| groupName | No | string | Group name filter |
| tags | No | array[string] | Tag name filter |
| chargeMode | No | int | 0=per minute, 1=monthly |
| openStatus | No | integer | 0=closed, 1=on |
| proxyIds | No | array[string] | Proxy IDs (max 10) |
| serialNos | No | array[string] | Serial numbers (max 100) |
Request Example
json
{
"page": 1,
"pageSize": 10,
"tags": ["tag1", "tag2"],
"openStatus": 1
}Response Fields
| Field | Type | Description |
|---|---|---|
| total | integer | Total cloud phones |
| page | integer | Current page |
| pageSize | integer | Page size |
| items[].id | string | Cloud phone ID |
| items[].serialName | string | Cloud phone name |
| items[].serialNo | string | Serial number |
| items[].status | int | 0=Started, 1=Starting, 2=Shut down |
| items[].group | object | Group info (id, name, remark) |
| items[].tags | array | Tag list |
| items[].equipmentInfo | object | Device info |
| items[].proxy | object | Proxy info |
| items[].chargeMode | int | 0=per minute, 1=monthly |
| items[].rpaStatus | int | 1=running, 0=not running |
| items[].monthlyExpire | int | Monthly expiration timestamp |
Equipment Info Fields
| Field | Type | Description |
|---|---|---|
| countryName | string | Country name |
| phoneNumber | string | Phone number |
| imei | string | IMEI |
| osVersion | string | System version |
| deviceBrand | string | Brand |
| deviceModel | string | Model |
| deviceName | string | Device name |
| netType | integer | 0=Wi-Fi, 1=Mobile |
| language | string | Cloud phone language |
Query Status
URL: https://openapi.geelark.com/open/v1/phone/statusMethod: POST
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| ids | Yes | array[string] | Cloud phone IDs (max 100) |
Response
Returns successDetails with status codes:
0- Started1- Starting2- Shut down3- Expired
json
{
"code": 0,
"data": {
"totalAmount": 4,
"successAmount": 3,
"failAmount": 1,
"successDetails": [
{ "id": "123456", "serialName": "name1", "status": 0 }
],
"failDetails": [
{ "code": 42001, "id": "789012", "msg": "env not found" }
]
}
}