Skip to content

Execute Shell Command ​

Execute shell command on cloud phone.

Interface Address:

text
/papi/container/operate/executeShell

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
ctrIdstringYesContainer ID
commandstringYesCommand to execute

Request Example:

json
{
  "ctrId": "cf5eaa177d75de7f43a0d95c84832560b70118e462dc2eb8da529a936d8c3c6f",
  "command": "ls"
}

Response Parameters:

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

Response Example:

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

OpenAPI Docs