zh:server_docs:robot_pipe:robot_pipe_cmd_set_task_mode_status

获取切换工作模式指令的执行状态

概述

  • API 用于获取机器人收到切换工作模式指令之后的切换状态和结果,用于给机器人下发切换工作模式的指令之后获取切换的状态和结果。

授权方式

数据维度授权 企业级授权 API 为企业级授权,企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式
接口维度授权 默认授权 API 为默认授权,您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式

请求

HTTP URL 路径 /v1/robot/pipe/cmd_set_task_mode/status
HTTP Method GET
参数 类型 必填 说明
Authorization string
  • 访问凭证 access_token
  • 格式:Bearer access_token
  • 示例:Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • 请参考:鉴权方法
参数 类型 必填 参数说明
msg_id string 下发切换工作模式指令的时候服务端返回的指令消息 msg_id,请参考 切换工作模式指令
# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/robot/pipe/cmd_set_task_mode/status?msg_id=test_msg_id' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'

响应

参数 类型 参数说明
code int 错误代码。0 是成功,非 0 是失败,请参考 错误代码
msg string 错误描述,当失败的时候会给出具体的错误描述。
req_id string 日志跟踪 id,当遇到问题需要猎户星空协助查问题时候,请提供此跟踪 id 值。
data object 业务数据 data 对象,详见下述 响应体 data 对象
参数 类型 参数说明
report_time string 最后一次机器人指令执行状态上报的时间,整数时间戳,单位是秒。在机器人还还未上报的时候此参数的值为 0。
report_data object 最后一次机器人指令执行状态上报的信息对象,请参考 机器人指令执行状态上报信息对象 report_data
参数 类型 参数说明
task_mode string 当前工作模式,请参考 切换工作模式指令如果机器人还未上报则不会返回此参数。
set_result string 切换状态和结果,0 是成功,非 0 是失败。如果机器人还未上报则不会返回此参数。
{
    "code": 0,
    "msg": "",
    "data": {
        "report_time": "1717075068",
        "report_data": {
            "task_mode": "deliver_meals",
            "set_result": "0"
        }
    }
}
  • 最后更改: 2024-06-11 17:37 +0800