Get Cloud Phone Page

Paginated query of cloud phone list by conditions.

Interface Address:

/papi/container/page

Request Method:

POST

Content-Type:

application/json

Header Parameters:

Parameter	Type	Required	Description
X-Access-Key	string	Yes	API access key ID. See API Rules for authentication details
X-Signature	string	Yes	Signature value, Base64-encoded HMAC-SHA256 result
X-Timestamp	string	Yes	Millisecond-level Unix timestamp (13 digits)
X-Nonce	string	Yes	Random string, 10~32 characters of lowercase letters and digits

Body Parameters:

Parameter	Type	Required	Description
pageNo	integer	No	Page number, starting from 1, default 1
pageSize	integer	No	Number of items per page, max 1000, default 10
name	string	No	Can query cloud phones by container name, cloud phone remark, or container IP
status	integer	No	Container status. Enum: 1-Powered off, 2-Powering on, 3-Restarting, 4-Powering off, 5-Resetting, 6-Deleting, 7-Running, 8-Deleted
sortType	integer	No	Sort type. Enum: 1-Device name ascending, 2-Device name descending, 3-Device duration ascending, 4-Device duration descending
containerSidList	array[string]	No	Container ID list
groupSid	string	No	Group ID
aliasCode	string	No	Spec code alias
authType	integer	No	Authorization type. Enum: 0-Authorizable, 1-Authorized out, 2-Authorized by
os	integer	No	Android version, see AndroidVersionEnum
proxyIpUid	string	No	Proxy IP UID, used to filter cloud phones bound to this IP
filterBoundContainers	boolean	No	Whether to filter bound cloud phones. true means filter bound cloud phones, false means don't filter bound cloud phones

Request Example:

{
  "pageNo": 1,
  "pageSize": 10,
  "status": 7
}

Response Parameters:

Parameter	Type	Description
code	integer	Error code. See Error Codes
data	object	Response data
├─ list	array[object]	Cloud phone data list
├─├─ ctrId	string	Container ID
├─├─ roleId	integer	Role ID
├─├─ name	string	Container name
├─├─ ctrNameId	string	Container business ID
├─├─ autoRenewFlag	boolean	Whether auto-renewal is enabled
├─├─ share	boolean	Whether shared
├─├─ expire	integer	Expiration time (validity period)
├─├─ status	integer	Status
├─├─ ctrName	string	Container name
├─├─ ctrMobileModel	string	Model
├─├─ ctrAlias	string	Container alias
├─├─ remark	string	Cloud phone remark
├─├─ ctrRemark	string	Cloud phone remark
├─├─ ctrIp	string	Container IP
├─├─ bootstrapAt	integer	Boot time
├─├─ stopAt	integer	Shutdown time
├─├─ authNum	integer	Number of authorized users
├─├─ groupName	string	Group name
├─├─ cphoneProxyHost	string	Proxy IP
├─├─ refreshCount	integer	Free one-click refresh count
├─├─ payRefreshCount	integer	Paid one-click refresh count
├─├─ monthlyGiftCount	integer	Monthly free one-click refresh total count
├─├─ dest	string	Device IP encrypted string
├─├─ screenshotServiceUrl	string	Screenshot service URL
├─├─ turnServerUri	string	TURN server URI
├─├─ skuName	string	SKU name
├─├─ skuCode	string	SKU code
├─├─ aliasCode	string	Alias code
├─├─ androidVersion	string	Android version
├─├─ os	integer	Cloud phone OS
├─├─ level	integer	SKU level
├─├─ packageCode	string	Package code
├─├─ fpSign	string	Cloud phone operation API authentication signature
├─├─ topFlag	boolean	Whether pinned to top
├─├─ ossServiceApiUrl	string	OSS service API URL
├─├─ operateFlag	boolean	Whether has operation permission
├─├─ authType	integer	Authorization type. 0-Ordinary, 1-Authorized, 2-Authorized by
├─ total	integer	Total count
msg	string	Error message

Response Example:

{
  "code": 0,
  "data": {
    "list": [
      {
        "ctrId": "ctr-xxx",
        "roleId": 0,
        "name": "Test-Phone-01",
        "ctrNameId": "ctrNameId-xxx",
        "autoRenewFlag": false,
        "share": false,
        "expire": 1735689600000,
        "status": 7,
        "ctrName": "Test-Phone-01",
        "ctrMobileModel": "SM-G9880",
        "ctrAlias": "22d6sr1gii",
        "remark": "remark",
        "ctrRemark": "cloud phone remark",
        "ctrIp": "192.168.1.100",
        "bootstrapAt": 1735689600000,
        "stopAt": 0,
        "authNum": 0,
        "groupName": "Default Group",
        "cphoneProxyHost": "",
        "refreshCount": 10,
        "payRefreshCount": 0,
        "monthlyGiftCount": 10,
        "dest": "encrypted-xxx",
        "screenshotServiceUrl": "https://screenshot.example.com",
        "turnServerUri": "turn:turn.example.com:3478",
        "skuName": "Standard",
        "skuCode": "standard",
        "aliasCode": "std",
        "androidVersion": "Android 12",
        "os": 12,
        "level": 1,
        "packageCode": "pkg-xxx",
        "fpSign": "sign-xxx",
        "topFlag": false,
        "ossServiceApiUrl": "https://oss.example.com",
        "operateFlag": true,
        "authType": 0
      }
    ],
    "total": 100
  },
  "msg": "success"
}