| 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. |
| HTTP URL Path | /v1/robot/pipe/cmd_set_task_mode/status |
| HTTP Method | GET |
| Parameter | Type | Required | Description |
| msg_id | string | Yes | The msg_id returned by the server when send the command to switch the working mode. Please refer to Switch Working Mode Command |
# Please replace the entry point with yours according to your region
curl --location 'https://global-openapi.orionstar.com/v1/robot/pipe/cmd_set_task_mode/status?msg_id=test_msg_id' \
--header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
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 |
| report_time | string | The time of the last report on the execution status of robot commands, represented as an integer timestamp in seconds. The value of this parameter is 0 when the robot has not reported yet. |
| report_data | object | The information object of the last report on the execution status of robot commands, please refer to Robot Command Execution Status Report Information Object report_data. |
Robot Command Execution Status Report Information Object report_data
| Parameter | Type | Description |
| task_mode | string | Current working mode. Please refer to Switch Working Mode Command。If the robot has not reported yet, this parameter will not be returned. |
| set_result | string | switching status and result, 0 means success, non-zero means failure. If the robot has not reported yet, this parameter will not be returned. |
Response Body Example
{
"code": 0,
"msg": "",
"data": {
"report_time": "1717075068",
"report_data": {
"task_mode": "deliver_meals",
"set_result": "0"
}
}
}