Skip to content

Get Cloud Phone List

Fresh

List Cloud Phones

URL: https://openapi.geelark.com/open/v1/phone/listMethod: POST

Pagination Parameters

ParameterRequiredTypeDescription
pageNointegerPage number (min 1)
pageSizeNointegerRecords per page (1-100)

Query Parameters

ParameterRequiredTypeDescription
idsNoarray[string]Cloud phone IDs (max 100, overrides pagination)
serialNameNostringCloud phone name filter
remarkNostringRemark filter
groupNameNostringGroup name filter
tagsNoarray[string]Tag name filter
chargeModeNoint0=per minute, 1=monthly
openStatusNointeger0=closed, 1=on
proxyIdsNoarray[string]Proxy IDs (max 10)
serialNosNoarray[string]Serial numbers (max 100)

Request Example

json
{
  "page": 1,
  "pageSize": 10,
  "tags": ["tag1", "tag2"],
  "openStatus": 1
}

Response Fields

FieldTypeDescription
totalintegerTotal cloud phones
pageintegerCurrent page
pageSizeintegerPage size
items[].idstringCloud phone ID
items[].serialNamestringCloud phone name
items[].serialNostringSerial number
items[].statusint0=Started, 1=Starting, 2=Shut down
items[].groupobjectGroup info (id, name, remark)
items[].tagsarrayTag list
items[].equipmentInfoobjectDevice info
items[].proxyobjectProxy info
items[].chargeModeint0=per minute, 1=monthly
items[].rpaStatusint1=running, 0=not running
items[].monthlyExpireintMonthly expiration timestamp

Equipment Info Fields

FieldTypeDescription
countryNamestringCountry name
phoneNumberstringPhone number
imeistringIMEI
osVersionstringSystem version
deviceBrandstringBrand
deviceModelstringModel
deviceNamestringDevice name
netTypeinteger0=Wi-Fi, 1=Mobile
languagestringCloud phone language

Query Status

URL: https://openapi.geelark.com/open/v1/phone/statusMethod: POST

Request Parameters

ParameterRequiredTypeDescription
idsYesarray[string]Cloud phone IDs (max 100)

Response

Returns successDetails with status codes:

  • 0 - Started
  • 1 - Starting
  • 2 - Shut down
  • 3 - 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" }
    ]
  }
}

GEELark API Documentation - Built with VitePress