Take or return control of the Android device

Take or return control of the Android device

control: true records (or renews; the view repeats it every minute) that a person in this view holds the device, before the response: once it returns 200, the agent's further device input is refused until the hold is returned or lapses after 150 seconds without renewal. An input event the agent had already sent still completes. control: false removes this view's hold only. 409 when the device is not running.

POST/api/sandbox/android-device/control
Body
vaultIdstringrequired
workflowIdstring
agentSessionIdstring
viewTokenstringrequired
controlbooleanrequired

Request

curl
curl -X POST https://trickest.io/api/sandbox/android-device/control \
  -H "Authorization: Token $TRICKEST_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ }'

Responses

200Recorded
successboolean
400Bad Request – validation error or malformed input
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

401Unauthorized – missing or expired token
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

403Forbidden – insufficient permissions
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

429Too Many Requests – rate limited
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

500Internal Server Error
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.