Skip to content
API Reference
/
/
/
List Cloud Phone Profiles

List Cloud Phone Profiles

Request

List the Cloud Phones visible to the authenticated team, page by page.

  • Effect: none. Read-only. Safe to retry with bounded backoff.
  • Note: phones of all device types are returned. Passwords of managed and dynamic proxies are removed from the response.
  • Use: this and /cloudphone/info are the completion signals for the asynchronous power, one-click-new-device and provisioning operations.
Bodyapplication/jsonrequired
bindIpboolean

Whether IP is bound: true = bound, false = not

Example:false
keywordstring

Keyword to filter: proxy info, group name, tag name, environment name

Example:"CP-424"
pageNointeger, (int64)

Current page

Example:1
pageSizeinteger, (int64)

Items per page

Example:100
sortArray of objects

Dynamic sort fields. Currently only "envName" is supported for cloud phones.

Example:
[
  {
    "sortDirection": "asc",
    "sortField": "envName"
  }
]
curl -i -X POST \
  http://127.0.0.1:40000/api/cloudphone/page \
  -H 'Content-Type: application/json' \
  -d '{
    "bindIp": false,
    "keyword": "CP-424",
    "pageNo": 1,
    "pageSize": 100,
    "sort": [
      {
        "sortDirection": "asc",
        "sortField": "envName"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstring or nullrequired

error message

dataobjectrequired
requestIdstringrequired

Operation Request ID

Response
{
  "code": 0,
  "msg": null,
  "data": {
    "current": "1",
    "dataList": [ … ],
    "pages": "1",
    "total": "1"
  },
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"
}