Skip to content

Connect Cloud Phone ​

Get cloud phone connection configuration info.

Interface Address:

text
/papi/container/operate/getConnectConfig

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

ParameterTypeRequiredDescription
X-Access-KeystringYesAPI access key ID. See API Rules for authentication
X-SignaturestringYesSignature value, Base64-encoded HMAC-SHA256 result
X-TimestampstringYesMillisecond-level Unix timestamp (13 digits)
X-NoncestringYesRandom string, 10-32 lowercase letters and digits

Body Parameters:

ParameterTypeRequiredDescription
ctrAliasstringYesContainer alias

Request Example:

json
{
  "ctrAlias": "22d6sr1gii"
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataBaseWebSocketConnectVOResponse data
├─ aliasstringAlias
├─ signalServerUrlstringSignaling server URL
├─ spareSignalstringSpare signaling
├─ roomIdstringRoom ID
├─ turnServerUristringTURN server URI
├─ isControlbooleanWhether to control
├─ tokenstringAuthentication token
├─ hostTurnarray[string]Primary relay
├─ spareTurnarray[string]Spare relay
├─ expiresintegerExpiration time
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": {
    "alias": "",
    "signalServerUrl": "",
    "spareSignal": "",
    "roomId": "",
    "turnServerUri": "",
    "isControl": false,
    "token": "",
    "hostTurn": [""],
    "spareTurn": [""],
    "expires": 0
  },
  "msg": ""
}

OpenAPI Docs