Skip to content

Get Cloud Phone Group Control List ​

Get cloud phone group control list.

Interface Address:

text
/papi/container/containerList

Request Method:

text
POST

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:

No request body parameters.

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataarray[object]Response data
├─ aliasstringAlias
├─ signalServerUrlstringSignaling server URL
├─ spareSignalstringSpare signaling
├─ roomIdstringRoom ID
├─ turnServerUristringTURN server URI
├─ isControlbooleanWhether has control
├─ tokenstringAuthentication token
├─ hostTurnarray[string]Primary TURN servers
├─ spareTurnarray[string]Spare TURN servers
├─ expiresintegerExpiration time
├─ signstringSignature
├─ ctrAliasstringAlias
├─ groupNamestringGroup name
├─ ctrIpstringIP
├─ ctrIdstringContainer ID
├─ ctrNamestringCloud phone name
├─ ctrRemarkstringCloud phone remark
├─ screenshotServiceUrlstringScreenshot service URL
├─ deststringDevice IP encrypted string
├─ ossServiceApiUrlstringOSS service API URL
├─ statusintegerCloud phone status
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": [
    {
      "alias": "22d6sr1gii",
      "signalServerUrl": "https://signal.example.com",
      "spareSignal": "https://spare-signal.example.com",
      "roomId": "room-xxx",
      "turnServerUri": "turn:turn.example.com:3478",
      "isControl": true,
      "token": "token-xxx",
      "hostTurn": [
        "turn:host1.example.com:3478"
      ],
      "spareTurn": [
        "turn:spare1.example.com:3478"
      ],
      "expires": 1735689600000,
      "sign": "sign-xxx",
      "ctrAlias": "22d6sr1gii",
      "groupName": "Default Group",
      "ctrIp": "192.168.1.100",
      "ctrId": "ctr-xxx",
      "ctrName": "Test-Phone-01",
      "ctrRemark": "cloud phone remark",
      "screenshotServiceUrl": "https://screenshot.example.com",
      "dest": "encrypted-xxx",
      "ossServiceApiUrl": "https://oss.example.com",
      "status": 7
    }
  ],
  "msg": "success"
}

OpenAPI Docs