Table of Contents

导航到指定点位指令

概述

授权方式

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

请求

请求域名

区域 域名
中国区 https://openapi.orionstar.com
欧洲区 https://global-openapi.orionstar.com
美国区 https://us-openapi.orionstar.com
日本区 https://jp-openapi.orionstar.com

请求协议

HTTP URL 路径 /v1/robot/pipe/cmd_navigation
HTTP Method POST
Content-Type application/x-www-form-urlencoded

公共请求头

参数 类型 必填 说明
Authorization string 是
  • 访问凭证 access_token
  • 格式：Bearer access_token
  • 示例：Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • 请参考：鉴权方法

请求体参数

参数 类型 必填 参数说明
robot_sn string 是 机器人 sn，多个 sn 请用英文逗号分隔。
is_batch int 是 传递常量值 1
msg_value string 是 导航目的点位名称
confirm_timeout int 否 机器人端倒计时确认框的倒计时秒数，传递 0 则不弹出倒计时确认框（立即执行导航）。

请求 cURL 示例

# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/robot/pipe/cmd_navigation' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'robot_sn=test_sn' \
     --data-urlencode 'is_batch=1' \
     --data-urlencode 'msg_value=会议室'

响应

公共响应体

参数 类型 参数说明
code int 错误代码。0 是成功，非 0 是失败，请参考 错误代码。
msg string 错误描述，当失败的时候会给出具体的错误描述。
req_id string 日志跟踪 id，当遇到问题需要猎户星空协助查问题时候，请提供此跟踪 id 值。
data object 业务数据 data 对象，详见下述 响应体 data 对象。

响应体 data 对象

参数 类型 参数说明
result_list array 指令下发提交结果信息对象列表数组，数组的每个元素都是一个机器人指令下发提交结果信息对象，请参考 机器人指令下发提交结果信息对象。

机器人指令下发提交结果信息对象

参数 类型 参数说明
ret string 提交结果错误代码。0 是成功，非 0 是失败。
msg string 提交结果错误描述。当失败的时候会给出具体的错误描述。
msg_id string 全局唯一的指令消息 id
robot object 机器人基本信息对象
robot.robot_sn string 机器人 sn，可用于在批量下发指令的场景下（请求参数的 robot_sn 传递了多个 sn）和请求的机器人 sn 进行对应。

响应体示例

{
    "code": 0,
    "msg": "",
    "data" : {
        "result_list": [
            {
                "ret": "0",
                "msg": "",
                "msg_id": "test_msg_id",
                "robot": {
                    "robot_sn": "test_sn",
                }
            },
            // ... 其他机器人的指令下发提交结果信息
        ]
    }
}