Skip to content

Get Cloud Phone Group Tree ​

Get cloud phone group tree structure.

Interface Address:

text
/papi/container/group-tree

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

ParameterTypeRequiredDescription
X-Access-KeystringYesAPI access key ID. See API Rules for authentication details
X-SignaturestringYesSignature value, Base64-encoded HMAC-SHA256 result
X-TimestampstringYesMillisecond-level Unix timestamp (13 digits)
X-NoncestringYesRandom string, 10~32 characters of lowercase letters and digits

Body Parameters:

ParameterTypeRequiredDescription
sortTypeintegerNoSort type. Enum: 1-Device name ascending, 2-Device name descending, 3-Device duration ascending, 4-Device duration descending

Request Example:

json
{
  "sortType": 1
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataarray[object]Response data, group tree list
├─ namestringGroup name
├─ sortintegerDisplay order
├─ sidstringGroup ID
├─ systemFlagbooleanWhether system default group
├─ containerCountintegerContainer count
├─ containersarray[object]Container list under the group
├─├─ ctrIdstringContainer ID
├─├─ remarkstringRemark
├─├─ statusintegerStatus
├─├─ namestringContainer name
├─├─ expireintegerAuthorization expiration time
├─├─ ctrNameIdstringBusiness ID, same as the cloud phone resource's ctr_alias
├─├─ ctrNamestringContainer name
├─├─ ctrRemarkstringContainer remark name
├─├─ androidVersionstringAndroid version
├─├─ osintegerCloud phone OS
├─├─ skuCodestringSKU code
├─├─ skuNamestringSKU name
├─├─ aliasCodestringAlias code
├─├─ multiplenumberExchange multiplier
├─├─ levelintegerLevel
├─├─ packageCodestringPackage code
├─├─ signstringSignature
├─├─ screenshotServiceUrlstringScreenshot service URL
├─├─ deststringDevice IP encrypted string
├─├─ ctrAliasstringContainer alias
├─├─ topFlagbooleanWhether pinned to top
├─├─ operateFlagbooleanWhether resource table container, only resource table containers have operation permission
├─├─ authTypeintegerAuthorization type. 0-Ordinary, 1-Authorized, 2-Authorized by
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": [
    {
      "name": "Default Group",
      "sort": 0,
      "sid": "group-sid-xxx",
      "systemFlag": true,
      "containerCount": 2,
      "containers": [
        {
          "ctrId": "ctr-xxx",
          "remark": "remark",
          "status": 7,
          "name": "Test-Phone-01",
          "expire": 1735689600000,
          "ctrNameId": "22d6sr1gii",
          "ctrName": "Test-Phone-01",
          "ctrRemark": "cloud phone remark",
          "androidVersion": "Android 12",
          "os": 12,
          "skuCode": "standard",
          "skuName": "Standard",
          "aliasCode": "std",
          "multiple": 1.0,
          "level": 1,
          "packageCode": "pkg-xxx",
          "sign": "sign-xxx",
          "screenshotServiceUrl": "https://screenshot.example.com",
          "dest": "encrypted-xxx",
          "ctrAlias": "22d6sr1gii",
          "topFlag": false,
          "operateFlag": true,
          "authType": 0
        }
      ]
    }
  ],
  "msg": "success"
}

OpenAPI Docs