Get Cloud Phone Group Control List
Get cloud phone group control list.
Interface Address:
text
/papi/container/containerListRequest Method:
text
POSTHeader 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:
No request body parameters.
Response Parameters:
| Parameter | Type | Description |
|---|---|---|
| code | integer | Error code. See Error Codes |
| data | array[object] | Response data |
| ├─ alias | string | Alias |
| ├─ signalServerUrl | string | Signaling server URL |
| ├─ spareSignal | string | Spare signaling |
| ├─ roomId | string | Room ID |
| ├─ turnServerUri | string | TURN server URI |
| ├─ isControl | boolean | Whether has control |
| ├─ token | string | Authentication token |
| ├─ hostTurn | array[string] | Primary TURN servers |
| ├─ spareTurn | array[string] | Spare TURN servers |
| ├─ expires | integer | Expiration time |
| ├─ sign | string | Signature |
| ├─ ctrAlias | string | Alias |
| ├─ groupName | string | Group name |
| ├─ ctrIp | string | IP |
| ├─ ctrId | string | Container ID |
| ├─ ctrName | string | Cloud phone name |
| ├─ ctrRemark | string | Cloud phone remark |
| ├─ screenshotServiceUrl | string | Screenshot service URL |
| ├─ dest | string | Device IP encrypted string |
| ├─ ossServiceApiUrl | string | OSS service API URL |
| ├─ status | integer | Cloud phone status |
| msg | string | Error 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"
}