Reboot Command
Overview
- This API is used to send a command to the robot to reboot, remotely controlling the robot to reboot.
Notes
- Please use the reboot command with caution. After rebooting, the robot needs to reconnect to the network before it can be remotely controlled again;
- If your WiFi requires special authentication (such as periodic web authentication, regular password changes, etc.), the robot may fail to automatically connect to WiFi after rebooting, which could result in the robot being unable to be remotely controlled;
Authorization
| Data Dimension Authorization | Enterprise-level Authorization | This API requires enterprise-level authorization. Both enterprise-level and agent-level authorization accounts can call this API. Please refer to Authorization Methods. |
|---|
| Interface Dimension Authorization | Default Authorization | This API is granted by default, so you don't need to apply for interface dimension authorization separately for your authorization account. Please refer to Authorization Methods. |
|---|
Request
Request Entry Point
| Region | Entry Point |
|---|---|
| China Region | https://openapi.orionstar.com |
| Europe Region | https://global-openapi.orionstar.com |
| USA Region | https://us-openapi.orionstar.com |
| Japan Region | https://jp-openapi.orionstar.com |
Request Protocol
| HTTP URL Path | /v1/robot/pipe/cmd_reboot |
|---|---|
| HTTP Method | POST |
| Content-Type | application/x-www-form-urlencoded |
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| robot_sn | string | Yes | Robot SN, separated by commas if multiple. |
cURL Request Example
# Please replace the entry point with yours according to your region curl --location 'https://global-openapi.orionstar.com/v1/robot/pipe/cmd_reboot' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'robot_sn=test_sn'
Response
Common Response Body
| Parameter | Type | Description |
|---|---|---|
| code | int | Error code. 0 means success, non-zero means failure, Please refer to Error Codes. |
| msg | string | Error description. When there is a failure, a specific error description will be provided. |
| req_id | string | Log tracking ID. When encountering problems that require assistance from OrionStar, please provide this tracking ID value. |
| data | object | Business data object, see below for details Response Body Data Object. |
Response Body Data Object
| Parameter | Type | Description |
|---|---|---|
| result_list | array | An array of objects containing information about the results of command submissions to robots. Each element in the array is an object representing the result of a command submission. Please refer to Robot Command Submission Result Information Object for details. |
Robot Command Submission Result Information Object
| Parameter | Type | Description |
|---|---|---|
| ret | string | Error code of the submission result. 0 indicates success, non-zero indicates failure. |
| msg | string | Error description of the submission result. A specific error description is provided in case of failure. |
| msg_id | string | Global unique ID of the command message |
| robot | object | Basic information object of the robot |
| robot.robot_sn | string | Robot SN, used for corresponding with the robot_sn passed in batch command submission scenarios (where multiple SNs are passed as request parameters) and the SN of the requested robot. |
Response Body Example
{ "code": 0, "msg": "", "data" : { "result_list": [ { "ret": "0", "msg": "", "msg_id": "test_msg_id", "robot": { "robot_sn": "test_sn", } }, // ... Other information about command submission results for robots ] } }