Skip to content

Get All Cloud Phone List ​

Get all cloud phone list.

Interface Address:

text
/papi/container/all-container

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
groupSidstringNoGroup SID
expireFlagbooleanNoWhether expired
proxyIpUidstringNoProxy IP UID, used to filter cloud phones bound to this IP

Request Example:

json
{
  "groupSid": "group-xxx",
  "expireFlag": false
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataarray[object]Response data
├─ expireintegerExpiration time (validity period)
├─ ctrAliasstringAlias
├─ ctrIdstringContainer ID
├─ ctrNameIdstringContainer business ID
├─ groupNamestringGroup name
├─ ctrNamestringCloud phone name
├─ ctrRemarkstringCloud phone remark
├─ levelintegerCloud phone level
├─ skuCodestringCloud phone SKU code
├─ skuNamestringCloud phone SKU name
├─ aliasCodestringSpec code alias
├─ statusintegerCloud phone status
├─ fpSignstringSignature
├─ screenshotServiceUrlstringScreenshot service URL
├─ deststringDevice IP encrypted string
├─ operateFlagbooleanOperation permission
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": [
    {
      "expire": 1735689600000,
      "ctrAlias": "22d6sr1gii",
      "ctrId": "ctr-xxx",
      "ctrNameId": "ctrNameId-xxx",
      "groupName": "Default Group",
      "ctrName": "Test-Phone-01",
      "ctrRemark": "cloud phone remark",
      "level": 1,
      "skuCode": "standard",
      "skuName": "Standard",
      "aliasCode": "std",
      "status": 7,
      "fpSign": "sign-xxx",
      "screenshotServiceUrl": "https://screenshot.example.com",
      "dest": "encrypted-xxx",
      "operateFlag": true
    }
  ],
  "msg": "success"
}

OpenAPI Docs