获取机器人地图点位列表

此 API 用于获取机器人地图点位列表；

数据维度授权	企业级授权	此 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/map/position_list
HTTP Method	GET

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

参数	类型	必填	参数说明
robot_sn	string	是	机器人 sn。
pos_name	string	否	点位名称，完全匹配。不传递则不限制。
lang	string	否	语言，默认是 zh_CN。例如 zh_CN / en_US 等。

# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/robot/map/position_list?robot_sn=test_robot_sn' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'

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

参数	类型	参数说明
position_list	array	机器人地图点位信息对象列表数组，此数组中的每个元素都是一个机器人地图点位信息对象。
position_list[].position	object	机器人地图点位信息对象，请参考 position - 机器人地图点位信息对象。

参数	类型	参数说明
map_name	string	地图名称
pos_name	string	点位名称

{
    "code": 0,
    "msg": "",
    "data": {
        "position_list" : [
            {
                "position" : {
                    "map_name": "地图1",
                    "pos_name": "点位A"
                },
            },
            // ... 其他地图点位信息
        ]
    }
}

获取机器人地图点位列表

概述

授权方式

请求

请求域名

请求协议

公共请求头

请求 URL 参数

请求 cURL 示例

响应

公共响应体

响应体 data 对象

position - 机器人地图点位信息对象

响应体示例