Get Robot Map Position List


  • This API is used to get the list of robot map positions.

Authorization Method

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 Entry Point

HTTP URL Path /v1/robot/map/position_list
Parameter Type Required Description
Authorization string Yes
  • Access token
  • Format: Bearer access_token
  • Example: Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • Please refer to: Authentication Methods
Parameter Type Required Description
robot_sn string Yes Robot SN
pos_name string No Position name, fully matched. Not passed if not limited.
lang string No Language, default is zh_CN. For example, zh_CN / en_US, etc.
# Please replace the entry point with yours according to your region
curl --location 'https://global-openapi.orionstar.com/v1/robot/map/position_list?robot_sn=test_robot_sn' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'


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.
Parameter Type Description
position_list array Array of robot map position information objects, each element in this array is a robot map position information object.
position_list[].position object Robot map position information object, please refer to position - Robot Map Position Information Object
Parameter Type Description
map_name string Map name
pos_name string Position name
    "code": 0,
    "msg": "",
    "data": {
        "position_list" : [
                "position" : {
                    "map_name": "MapA",
                    "pos_name": "PositionA"
            // ... Other map position information
  • Last modified: 2024-05-13 14:17 +0800