Skip to content

Set Cloud Phone Proxy ​

Set cloud phone proxy.

Interface Address:

text
/papi/container/operate/startProxy

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

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

Body Parameters:

ParameterTypeRequiredDescription
ctrIdstringYesContainer ID
proxyHoststringYesProxy host
proxyPortintegerYesProxy port
proxyTypeintegerYesProxy type (1-Socks5, 2-HTTP)
userNamestringNoProxy username
passwordstringNoProxy password
packageWhiteListstringNoPackage whitelist, comma-separated (format: com.example.app1,com.example.app2)
ipWhiteListstringNoIP whitelist, comma-separated (format: 192.168.1.1,192.168.1.2)
ipSimulationEnabledintegerNoEnable IP simulation (1-On, 0-Off)

Request Example:

json
{
  "ctrId": "cf5eaa177d75de7f43a0d95c84832560b70118e462dc2eb8da529a936d8c3c6f",
  "proxyHost": "38.175.217.136",
  "proxyPort": 10810,
  "proxyType": 1,
  "userName": "njZQKJkYGCzv",
  "password": "qhBqlupqI0aM",
  "packageWhiteList": "",
  "ipWhiteList": "",
  "ipSimulationEnabled": 1
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataContainerApiResultResponse data
├─ successbooleanWhether the operation succeeded
├─ taskIdstringTask ID of the operation
├─ dataobjectData
├─ msgstringMessage of the current operation
├─ ctrIdstringContainer CtrId
├─ ctrAliasstringContainer alias
├─ ctrSlotintegerCloud phone slot
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": {
    "success": true,
    "taskId": "",
    "data": {},
    "msg": "",
    "ctrId": "cf5eaa177d75de7f43a0d95c84832560b70118e462dc2eb8da529a936d8c3c6f",
    "ctrAlias": "",
    "ctrSlot": 0
  },
  "msg": ""
}

OpenAPI Docs