Orionstar Robot OpenAPI

https://openapi.orionstar.com/opendocs/zh
Admin
Orionstar Robot OpenAPI provides comprehensive documentation and interfaces for integrating with...
Tokens:111,981
Snippets:475
Trust Score:7.8
Update:9 months ago
Show doc for...
Tokens:
Raw
### Example API Request URL Construction (Chinese Region)

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/api_call_guide/calling_protocol

This example demonstrates how to construct a complete API request URL by combining the base domain for the China region with a specific API's URL path. It illustrates the process for fetching robot information.

```text
Domain: https://openapi.orionstar.com
URL Path: /v1/robot/robot_info
Request URL: https://openapi.orionstar.com/v1/robot/robot_info
```

--------------------------------

### Get Agency Corp List cURL Example

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/corp_info/index

This example demonstrates how to call the Get Agency Corp List API using cURL. It includes the necessary endpoint, authorization header, and query parameters. Ensure you replace 'YOUR-ACCESS-TOKEN' with your actual token and adjust the domain based on your region.

```bash
# Please replace the domain according to your region
curl --location 'https://openapi.orionstar.com/v1/corp/agency_corp_list?ov_agencyid=test_ov_agencyid' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
```

--------------------------------

### Request Machine Guide Introduction List using cURL

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

This cURL command retrieves a list of machine guide introductions. It requires an authorization token, enterprise ID, and a date range for comparison. The response contains details about guide sessions, including names, durations, and completion rates.

```bash
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_guide_introduction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'
```

--------------------------------

### Response Body Example with Robot and Task Information

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_info/robot_robot_info

An example of a full response body containing enterprise details, robot information, current robot status (if requested), and a list of current robot task events (if requested). This structure is returned by the robot task event API.

```json
{
    "code": 0,
    "msg": "",
    "data": {
        "corp": {
            "ov_corpid": "orion.ovs.entprise.12345678",
            "corp_name": "测试企业",
            "create_time": "1711966681",
            "update_time": "1711966681"
        },
        "robot": {
            "ov_corpid": "orion.ovs.entprise.12345678",
            "robot_uuid": "test_uuid",
            "robot_sn": "test_sn",
            "robot_name": "小豹",
            "robot_version": "V9.7.2024041200.1234US",
            "robot_model": "OS-R-DR01S",
            "bind_time": "1711966681",
            "online_status": "1"
        },
        "robot_report_status": {
            "battery": {
                "battery_rate": "85",
                "is_charging": "0",
                "update_time": "1712046236"
            },
            "task_info": {
                "task_name": "送餐中",
                "last_task_name": "等待送餐",
                "update_time": "1712046236"
            },
            "location": {
                "state": "ready",
                "pos_name": "A01",
                "pos_all_name": {
                    "zh_CN": "A01",
                    "en_US": ""
                },
                "emergency": "0",
                "update_time": "1712046236"
            }
        },
        "robot_task_list": [
            {
                "task_id": "test_task_id",
                "task_type": "meals_deliver_task-deliver",
                "event_type": "te__end",
                "task_time": "1712046163",
                "start_time": "1712046163",
                "update_time": "1712046237",
                "task_data": {
                    "pos_name": "A01"
                },
                "event_list": [
                    {
                        "event_type": "te__start",
                        "first_time": "1712046163",
                        "last_time": "1712046163"
                    },
                    {
                        "event_type": "te_arrived",
                        "first_time": "1712046236",
                        "last_time": "1712046236"
                    },
                    {
                        "event_type": "te__end",
                        "first_time": "1712046237",
                        "last_time": "1712046237"
                    }
                ]
            }
        ]
    }
}
```

--------------------------------

### Robot Task Event List Example

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_info/robot_robot_info

Provides an example of the `event_list` structure, which contains a history of events reported by the robot for a specific task. Each event includes its type and first/last reported times.

```json
[
    {
        "event_type": "te__start", // 事件类型
        "first_time": "1641881442", // 此实事件的首次上报时间
        "last_time": "1641881442" // 此事件的最后上报时间
    },
    {
        "event_type": "te_arrived",
        "first_time": "1641881443",
        "last_time": "1641881443"
    },
    {
        "event_type": "te__end",
        "first_time": "1641881444",
        "last_time": "1641881444"
    }
    // ... 省略其他任务事件
]
```

--------------------------------

### Robot Task Event Callback cURL Example

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/event_callback_guide/index

This snippet demonstrates how to simulate a robot task event callback using cURL. It includes all the necessary parameters for a multipart/form-data POST request to your specified callback URL. Ensure your callback URL can handle these parameters and content types.

```bash
curl --location 'https://your_domain.com/your_callback_url' \
     --form 'open_appid=test_appid' \
     --form 'open_code=b317979b11292276e0a1b49a08953dec' \
     --form 'robot_sn=test_sn' \
     --form 'ov_corpid=test_ov_corpid' \
     --form 'task_id=85b35e3b5fc452a0f7a6d2a60d9edb9b' \
     --form 'task_type=meals_deliver_task-deliver' \
     --form 'event_type=te_arrived' \
     --form 'task_data={"pos_name":"桌号A01"}' \
     --form 'event_data={"pos_name":"桌号A01"}'
```

--------------------------------

### Get Robot Information - cURL Example

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_info/robot_robot_info

This snippet demonstrates how to call the Get Robot Information API using cURL. It includes the necessary endpoint, query parameters like `robot_sn`, and the Authorization header. Ensure you replace `YOUR-ACCESS-TOKEN` with a valid token and use the correct regional domain.

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

--------------------------------

### Initial Response Body Example for Machine Guidance List

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

An initial example response body for the machine guidance list, showing a successful request with a code of 200 and a data object containing a list of items and pagination details.

```json
{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "count_time": "2024-02-01",
                "num": "242",
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.2413674089",
                "version": "V6.3",
                "finish_num": "0.00",
                "guide_duration": 39214.27,
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test_name"
            }
        ],
        "pagination": {
            "total": 1,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}
```

--------------------------------

### Machine Guide List API

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

Retrieves a list of machine guide data. This endpoint allows you to fetch statistics related to machine guidance, including counts, durations, and completion rates.

```APIDOC
## GET /proxyopen/dataopen/machine_guide_list

### Description
Retrieves a list of machine guide data. This endpoint allows you to fetch statistics related to machine guidance, including counts, durations, and completion rates.

### Method
GET

### Endpoint
/proxyopen/dataopen/machine_guide_list

### Parameters
#### Query Parameters
- **ov_corpid** (string) - Required - The corporate ID to filter the data.
- **compare** (string) - Required - A comma-separated string of dates for comparison (e.g., "2024-02-01,2024-02-03").

### Request Example
```bash
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_guide_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'
```

### Response
#### Success Response (200)
- **code** (integer) - The response status code.
- **msg** (string) - The response message.
- **data** (object) - The main data object.
  - **list** (array) - Array of guide data objects.
    - **list[].line_name** (string) - Name of the guide location.
    - **list[].count_time** (string) - The date of the count.
    - **list[].num** (string) - The count number.
    - **list[].finish_num** (string) - The number of completed tasks.
    - **list[].guide_duration** (float) - Total duration of guidance in seconds.
    - **list[].enterprise_id** (string) - The enterprise ID.
    - **list[].device_id** (string) - The device ID.
    - **list[].version** (string) - The device software version.
    - **list[].enterprise_name** (string) - The name of the enterprise.
    - **list[].pcate_name** (string) - The primary category name.
    - **list[].cate_name** (string) - The category name.
    - **list[].city** (string) - The city.
    - **list[].agency_name** (string) - The agency name (can be null).
    - **list[].device_name** (string) - The name of the device.
  - **pagination** (object) - Pagination information.
    - **total** (integer) - Total number of items.
    - **pageIndex** (integer) - Current page index.
    - **pageSize** (integer) - Number of items per page.

#### Response Example
```json
{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "line_name": "洗手间",
                "count_time": "2024-02-01",
                "num": "1",
                "finish_num": "1",
                "guide_duration": 39214.27,
                "enterprise_id": "orion.ovs.entprise.123456",
                "device_id": "test_sn",
                "version": "V6.5",
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test_name"
            }
        ],
        "pagination": {
            "total": 1,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}
```
```

--------------------------------

### POST /proxyopen/dataopen/machine_guide_introduction_list

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

Retrieves a list of machine guide introductions for a given enterprise within a specified date range.

```APIDOC
## POST /proxyopen/dataopen/machine_guide_introduction_list

### Description
Retrieves a list of machine guide introductions for a given enterprise within a specified date range.

### Method
POST

### Endpoint
/proxyopen/dataopen/machine_guide_introduction_list

### Parameters
#### Query Parameters
- **ov_corpid** (string) - Required - The ID of the enterprise.
- **compare** (string) - Required - A comma-separated string of dates for comparison (e.g., "2024-02-01,2024-02-03").

#### Request Body
This endpoint uses `x-www-form-urlencoded` data.

### Request Example
```
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_guide_introduction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **msg** (string) - The message associated with the response.
- **data** (object) - The data payload.
  - **list** (array) - An array of guide introduction objects.
    - **count_time** (string) - The date of the guide introduction.
    - **num** (string) - The number of guide introductions.
    - **line_name** (string) - The name of the guide line.
    - **device_id** (string) - The ID of the device.
    - **enterprise_id** (string) - The ID of the enterprise.
    - **version** (string) - The version of the device software.
    - **finish_num** (string) - The completion rate of the guide (%).
    - **duration_avg** (integer) - The average duration of the guide.
    - **guide_duration** (float) - The total duration of the guide in seconds.
    - **enterprise_name** (string) - The name of the enterprise.
    - **pcate_name** (string) - The category name of the enterprise.
    - **cate_name** (string) - The category name of the device.
    - **city** (string) - The city where the device is located.
    - **agency_name** (string or null) - The name of the agency.
    - **device_name** (string) - The name of the device.
  - **pagination** (object) - Pagination information.
    - **total** (integer) - The total number of items.
    - **pageIndex** (integer) - The current page index.
    - **pageSize** (integer) - The number of items per page.

#### Response Example
```json
{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "count_time": "2024-02-01",
                "num": "2",
                "line_name": "猎户星空导览",
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.123456",
                "version": "V6.3",
                "finish_num": "0.00",
                "duration_avg": 0,
                "guide_duration": 112.03,
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test_name"
            }
        ],
        "pagination": {
            "total": 3,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}
```
```

--------------------------------

### cURL Example: Get Robot Task Mode Status

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_pipe/robot_pipe_cmd_set_task_mode_status

Example of how to retrieve the robot's task mode change status using cURL. Requires specifying the region's domain, authorization token, and the message ID returned when the command was issued.

```curl
# Please replace the domain according to your region
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'
```

--------------------------------

### Get Robot Map Position List (cURL)

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_map_info/index

Example of how to call the Get Robot Map Position List API using cURL. Replace 'YOUR-ACCESS-TOKEN' with your actual access token and adjust the domain based on your region.

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

--------------------------------

### Request cURL Example for Machine Reception Introduction List

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

This cURL command illustrates how to query the machine reception introduction list. It shows the necessary headers and form data parameters for a successful request.

```shell
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_reception_introduction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'
```

--------------------------------

### Request cURL Example for Machine Guidance List

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

This example demonstrates how to make a cURL request to the machine guidance list endpoint. It includes setting the authorization header, content type, and passing relevant query parameters like `ov_corpid` and `compare`.

```shell
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_guide_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'
```

--------------------------------

### cURL Request Example for Get Corporation Info

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/corp_info/corp_corp_info

This snippet demonstrates how to call the Get Corporation Information API using cURL. It includes the endpoint URL, the required Authorization header, and a sample query parameter for the enterprise ID. Remember to replace 'YOUR-ACCESS-TOKEN' with your actual token and adjust the domain based on your region.

```shell
# Please replace the domain based on your region
curl --location 'https://openapi.orionstar.com/v1/corp/corp_info?ov_corpid=test_ov_corpid' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
```

--------------------------------

### cURL Example for sWebApi Access Initialization

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/corp_sso/sso_init_webapi_access

This snippet demonstrates how to initiate sWebApi access by switching the current login enterprise using cURL. It requires the regional domain, authorization token, and the target enterprise ID. The access_scope parameter is optional and specifies the virtual login scope.

```curl
# Please replace the domain based on your region
curl --location 'https://openapi.orionstar.com/v1/sso/init_webapi_access?ov_corpid=test_ov_corpid' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
```

--------------------------------

### Get Enterprise Map List (cURL)

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_map_info/corp_map_list

This example demonstrates how to fetch a list of maps for a specific enterprise using cURL. It requires an authorization token and the enterprise ID. The `map_name`, `page`, and `page_rows` parameters are optional for filtering and pagination.

```curl
# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/corp/map_list?ov_corpid=test_ov_corpid' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
```

--------------------------------

### Initiate Visitor Invitation using cURL

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/corp_visitor_invite/webcorp_user_visitor

This snippet demonstrates how to initiate a visitor invitation using a cURL command. It includes the necessary headers, URL, and form-urlencoded data parameters required for the API request. Ensure you replace 'YOUR-ACCESS-TOKEN' with a valid access token.

```bash
# Please replace the domain name according to your region
curl --location 'https://openapi.orionstar.com/proxyopen/webcorp/api/user/visitor' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'aim=开会' \
     --data-urlencode 'place=会议室' \
     --data-urlencode 'name=小明' \
     --data-urlencode 'phone=13812345678' \
     --data-urlencode 'inviter_name=小丽' \
     --data-urlencode 'inviter_dept=研发部' \
     --data-urlencode 'inviter_job=研发工程师' \
     --data-urlencode 'invitationtime=2024-04-02 10:00'
```

--------------------------------

### Device QA List Response Example

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_ovs/index

Example structure of the response when retrieving a list of QA pairs. It includes the total count of QA pairs and a list of QA items. Each QA item contains its ID, questions, text answers, and optionally image or video answer information. Note that image and video answers cannot coexist for the same QA pair.

```json
{
    "code": 0,
    "msg": "",
    "data": {
        "total_count": "10",
        "qa_list": [
            {
                "qapair_id": "test_id",
                "question": [
                    "展示图片"
                ],
                "answer": [
                    "图片答案"
                ],
                "image_info": [
                    {
                        "src": "https://test.com/test.png",
                        "width": 800,
                        "height": 600
                    }
                ],
                // 为了提供示例这里同时给出了图片和视频答案，真实场景不允许同时存在图片和视频答案
                "video_info": [
                    {
                        "backgroundImage": "https://test.com/test.png",
                        "imageWidth": 800,
                        "imageHeight": 600,
                        "src": "https://test.com/test.mp4"
                    }
                ]
            }
        ]
    }
}
```

--------------------------------

### Machine Reception Introduction List API

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

Retrieves a list of machine reception introduction data. This endpoint provides statistics on reception activities and introductions facilitated by machines.

```APIDOC
## GET /proxyopen/dataopen/machine_reception_introduction_list

### Description
Retrieves a list of machine reception introduction data. This endpoint provides statistics on reception activities and introductions facilitated by machines.

### Method
GET

### Endpoint
/proxyopen/dataopen/machine_reception_introduction_list

### Parameters
#### Query Parameters
- **ov_corpid** (string) - Required - The corporate ID to filter the data.
- **compare** (string) - Required - A comma-separated string of dates for comparison (e.g., "2024-02-01,2024-02-03").

### Request Example
```bash
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_reception_introduction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'
```

### Response
#### Success Response (200)
- **code** (integer) - The response status code.
- **msg** (string) - The response message.
- **data** (object) - The main data object.
  - **list** (array) - Array of reception introduction data objects.
    - **list[].line_name** (string) - Name of the reception/introduction.
    - **list[].num** (string) - The count number.
    - **list[].guide_duration** (float) - Total duration in seconds.
    - **list[].finish_num** (string) - Completion rate (%).
    - **list[].enterprise_id** (string) - The enterprise ID.
    - **list[].device_id** (string) - The device ID.
    - **list[].version** (string) - The device software version.
    - **list[].enterprise_name** (string) - The name of the enterprise.
    - **list[].pcate_name** (string) - The primary category name.
    - **list[].cate_name** (string) - The category name.
    - **list[].city** (string) - The city.
    - **list[].agency_name** (string) - The agency name (can be null).
    - **list[].device_name** (string) - The name of the device.
  - **pagination** (object) - Pagination information.
    - **total** (integer) - Total number of items.
    - **pageIndex** (integer) - Current page index.
    - **pageSize** (integer) - Number of items per page.

#### Response Example
```json
{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "line_name": "接待",
                "count_time": "2024-02-01",
                "num": "5",
                "guide_duration": 1200.5,
                "finish_num": "95.00",
                "enterprise_id": "orion.ovs.entprise.123456",
                "device_id": "test_sn",
                "version": "V6.5",
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test_name"
            }
        ],
        "pagination": {
            "total": 1,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}
```
```

--------------------------------

### cURL Example for Fetching Enterprise Map Positions

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_map_info/corp_map_position_list

This snippet demonstrates how to call the API using cURL to retrieve a list of map positions for a specified enterprise and map names. It requires the Authorization header with a valid access token and includes query parameters for the enterprise ID and map names.

```cURL
# Please replace the domain name according to your region
curl --location 'https://openapi.orionstar.com/v1/corp/map_position_list?ov_corpid=test_ov_corpid&map_name=testname1,testname2' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
```

--------------------------------

### Request cURL Example for Machine Inquiry List

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

This cURL example shows how to call the machine inquiry list endpoint. It specifies the endpoint URL, authorization token, content type, and required data parameters like `ov_corpid` and `compare`.

```shell
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_ask_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'
```

--------------------------------

### cURL Example: Calling Robot Info API with Access Token

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/authentication/validation

This snippet demonstrates how to call the Orionstar OpenAPI's 'Get Robot Information' API using cURL. It includes the necessary Authorization header with the 'Bearer' token and the API endpoint. Ensure the access_token and region are correctly configured.

```bash
curl --header 'Authorization: Bearer T.WcnhSdYj-kwVBpP27LRQrw.ori-67facfd90b2744220a5eae850e51' \
     --location 'https://openapi.orionstar.com/v1/robot/robot_info?robot_sn=test_sn'
```

--------------------------------

### Request Machine Patrol Introduction List using cURL

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

This snippet demonstrates how to request a list of machine patrol introductions via cURL. It uses an authorization token, enterprise ID, and a comparison date range. The response includes patrol session data such as number of patrols and duration.

```bash
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_patrol_introduction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'
```

--------------------------------

### Get Server External IP Address using cURL

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/authentication/grant

This snippet demonstrates how to retrieve your server's external IP address using a cURL command. This IP address is crucial for IP dimension authorization, as Orionstar needs to whitelist it for API access. The command should be executed on the server that will be calling the API.

```bash
curl --location 'https://openapi.orionstar.com/v1/myip'
```

--------------------------------

### GET /v1/corp/map_position_list

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_map_info/corp_map_position_list

Retrieves a list of map points for a given enterprise and map names.

```APIDOC
## GET /v1/corp/map_position_list

### Description
This API endpoint retrieves a list of map points within a specified enterprise and for given map names. It is designed for enterprise-level authorization.

### Method
GET

### Endpoint
/v1/corp/map_position_list

### Parameters
#### Path Parameters
None

#### Query Parameters
- **ov_corpid** (string) - Required - The enterprise ID.
- **map_name** (string) - Required - The map name(s), separated by English commas.

#### Request Body
None

### Request Example
```curl
# Please replace the domain according to your region
curl --location 'https://openapi.orionstar.com/v1/corp/map_position_list?ov_corpid=test_ov_corpid&map_name=testname1,testname2' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
```

### Response
#### Success Response (200)
- **code** (int) - Error code. 0 for success, non-zero for failure.
- **msg** (string) - Error description, providing specific details when an error occurs.
- **req_id** (string) - Log tracking ID for issue investigation.
- **data** (object) - The business data object, detailed below.

##### Response Body Data Object
- **map_position_list** (array) - An array of map information objects. Each element contains details about a map and its associated points.
  - **map** (object) - Map information object. Please refer to the 'map' object definition.
  - **position_list** (array) - An array of map point information objects for the current map.
    - **position** (object) - Map point information object. Please refer to the 'position' object definition.

##### Map Object (`map`)
- **map_id** (string) - The unique identifier for the map.
- **map_name** (string) - The name of the map.
- **create_time** (string) - The creation timestamp (in seconds).
- **update_time** (string) - The last update timestamp (in seconds).

##### Position Object (`position`)
- **map_name** (string) - The name of the map to which the point belongs.
- **pos_name** (string) - The name of the map point.

#### Response Example
```json
{
    "code": 0,
    "msg": "",
    "data": {
        "map_position_list" : [
            {
                "map" : {
                    "map_id": "test_id",
                    "map_name": "测试地图-0107152028",
                    "create_time": "1547021774",
                    "update_time": "1562222558"
                },
                "position_list" : [
                    {
                        "position" : {
                            "map_name": "测试地图-0107152028",
                            "pos_name": "点位A"
                        }
                    },
                    // ... other map point information
                ]
            },
            // ... other map information
        ]
    }
}
```
```

--------------------------------

### GET /v1/robot/robot_info

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_info/robot_robot_info

Retrieves information about a specific robot, optionally including its current status, task events, and location.

```APIDOC
## GET /v1/robot/robot_info

### Description
This endpoint retrieves information about a specific robot. You can also optionally request the robot's current status, task events, and location.

### Method
GET

### Endpoint
`/v1/robot/robot_info`

### Parameters
#### Query Parameters
- **robot_sn** (string) - Required - The unique serial number of the robot.
- **is_report_status** (int) - Optional - Whether to fetch the robot's current status information (e.g., battery, current task, current location). Defaults to 0 (not fetching).
  * 0: Do not fetch
  * 1: Fetch
- **is_report_task_event** (int) - Optional - Whether to fetch the robot's reported task event information. This parameter is effective only when used in conjunction with `report_task_type`. Only task events from the last 24 hours can be retrieved. Defaults to 0 (not fetching).
  * 0: Do not fetch
  * 1: Fetch
- **report_task_type** (string) - Optional - The types of robot-reported task events to fetch. Multiple types can be separated by English commas. This parameter is only effective when `is_report_task_event` is set to 1. Supported task types:
  * `meals_deliver_task-deliver` - Delivery task
  * `meals_deliver_task-return` - Return task after delivery

### Request Example
```
GET https://openapi.orionstar.com/v1/robot/robot_info?robot_sn=test_sn&is_report_status=1
Authorization: Bearer YOUR-ACCESS-TOKEN
```

### Response
#### Success Response (200)
- **code** (int) - Error code. 0 indicates success, non-zero indicates failure. Refer to Error Codes.
- **msg** (string) - Error description. Provides specific details when an error occurs.
- **req_id** (string) - Log tracking ID. Provide this ID to OrionStar support if you encounter issues.
- **data** (object) - Business data object. See the Response Body `data` object below for details.

#### Response Example
```json
{
  "code": 0,
  "msg": "Success",
  "req_id": "some_request_id",
  "data": {
    "corp": {
      "ov_corpid": "corp_id_123",
      "corp_name": "Example Corp",
      "create_time": 1678886400,
      "update_time": 1678886400
    },
    "robot": {
      "ov_corpid": "corp_id_123",
      "robot_uuid": "robot_uuid_abc",
      "robot_sn": "test_sn",
      "robot_name": "DeliveryBot-01",
      "robot_version": "V9.7.2024041200.1234US",
      "robot_model": "OS-R-DR01S",
      "bind_time": 1678886400,
      "expires_time": 1711966681,
      "online_status": "1"
    },
    "robot_report_status": {
      "battery": {
        "battery_rate": "85%",
        "is_charging": "0"
      },
      "task_info": {
        "task_name": "delivering_meal",
        "last_task_name": "waiting_for_order"
      },
      "location": {
        "state": "ready",
        "pos_name": "Lobby",
        "pos_all_name": {
          "zh_CN": "大堂",
          "en_US": "Lobby"
        },
        "emergency": "0"
      }
    }
  }
}
```

## Response Body `data` Object Details:

### `corp` - Enterprise Information Object
- **ov_corpid** (string) - Enterprise ID.
- **corp_name** (string) - Enterprise name.
- **create_time** (string) - Creation time (Unix timestamp in seconds).
- **update_time** (string) - Last modification time (Unix timestamp in seconds).

### `robot` - Robot Information Object
- **ov_corpid** (string) - Enterprise ID the robot belongs to.
- **robot_uuid** (string) - Robot UUID.
- **robot_sn** (string) - Robot serial number.
- **robot_name** (string) - Robot name.
- **robot_version** (string) - Robot ROM version (e.g., `V9.7.2024041200.1234US`).
- **robot_model** (string) - Robot model (e.g., `OS-R-DR01S`).
- **bind_time** (string) - Time of the last binding to the current enterprise (Unix timestamp in seconds).
- **expires_time** (string) - Lease expiration time (Unix timestamp in seconds). Only applicable for leased robots.
- **online_status** (string) - Robot online status, determined by heartbeat signals with approximately 15 seconds delay.
  * 0: Offline
  * 1: Online

### `robot_report_status` - Robot Current Status Information Object (Returned only if `is_report_status=1`)
- **battery** (object) - Robot's current battery information.
  - **battery_rate** (string) - Current battery percentage.
  - **is_charging** (string) - Whether the robot is currently charging.
    * 0: No
    * 1: Yes
- **task_info** (object) - Robot's current task information object.
  - **task_name** (string) - Name of the robot's current task (e.g., "delivering_meal"). Refer to Common Task Names.
  - **last_task_name** (string) - Name of the robot's last executed task (e.g., "waiting_for_order"). Refer to Common Task Names.
- **location** (object) - Robot's current location information object.
  - **state** (string) - Robot's localization status.
    * `ready`: Localization successful
    * `get_lost`: Localization failed
  - **pos_name** (string) - Default language name of the robot's current location.
  - **pos_all_name** (object) - Multi-language name information object for the robot's current location.
    - **zh_CN** (string) - Robot's current location in Chinese. Only effective if the robot reports its current location in Chinese; otherwise, it's an empty string.
    - **en_US** (string) - Robot's current location in English. Only effective if the robot reports its current location in English; otherwise, it's an empty string.
  - **emergency** (string) - Whether the robot is in an emergency stop state.
    * 0: No
    * 1: Yes

### `robot_task_list` - Robot Task Event Information Object Array (Returned only if `is_report_task_event=1` and `report_task_type` is valid)
- Each element in the array is a `robot_task` object representing a robot task event. Only task events from the last 24 hours can be retrieved.

#### `robot_task` - Robot Task Event Information Object
- **task_id** (string) - Unique identifier for the task.
- **task_type** (string) - The type of the task (e.g., `meals_deliver_task-deliver`).
- **start_time** (string) - The time when the task started (Unix timestamp in seconds).
- **end_time** (string) - The time when the task ended (Unix timestamp in seconds).
- **status** (string) - The status of the task (e.g., `completed`, `failed`).
- **details** (object) - Additional details specific to the task type.
```

--------------------------------

### Orionstar OpenAPI: Keyword Word Cloud Summary Response Example

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/big_data/bxm_robot_usage_data

Example of a response from the Orionstar OpenAPI for keyword word cloud summaries. It indicates a successful operation with a code of 200 and provides a data object containing a list of datasets with names, counts, and percentages.

```json
{
    "code": 200,
    "msg": "",
    "data": {
        "source": [
            {
                "dataset": [
                    {
                        "name": "日历",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "其他",
                        "num": "72",
                        "percent": "38.92"
                    },
                    {
                        "name": "导览",
                        "num": "0",
                        "percent": "0.00"
                    },
                    {
                        "name": "娱乐",
                        "num": "2",
                        "percent": "1.08"
                    },
                    {
                        "name": "问答",
                        "num": "26",
                        "percent": "14.05"
                    },
                    {
                        "name": "轻应用",
                        "num": "2",
                        "percent": "1.08"
                    },
                    {
                        "name": "播报PPT",
                        "num": "0",
                        "percent": "0.00"
                    },
                    {
                        "name": "媒体指令",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "聊天",
                        "num": "55",
                        "percent": "29.73"
                    },
                    {
                        "name": "天气",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "导航",
                        "num": "0",
                        "percent": "0.00"
                    },
                    {
                        "name": "接待",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "打开APP",
                        "num": "0",
                        "percent": "0.00"
                    },
                    {
                        "name": "验证码",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "问路引领",
                        "num": "6",
                        "percent": "3.24"
                    },
                    {
                        "name": "通用指令",
                        "num": "10",
                        "percent": "5.41"
                    },
                    {
                        "name": "注册",
                        "num": "0",
                        "percent": "0.00"
                    }
                ],
                "name": "不同类型交互占比"
            }
        ]
    }
}
```

--------------------------------

### GET /v1/corp/map_list

Source: https://openapi.orionstar.com/opendocs/zh/server_docs/robot_map_info/corp_map_list

Retrieves a list of maps for a given enterprise. Supports filtering by map name and pagination.

```APIDOC
## GET /v1/corp/map_list

### Description
This API is used to obtain the list of maps under an enterprise.

### Method
GET

### Endpoint
`/v1/corp/map_list`

### Parameters
#### Query Parameters
- **ov_corpid** (string) - Required - Enterprise ID.
- **map_name** (string) - Optional - Map name, exact match. If not provided, there is no limit.
- **page** (int) - Optional - Pagination parameter. The current page number, starting from 1, defaults to 1.
- **page_rows** (int) - Optional - Pagination parameter. Number of data items per page, defaults to 1.

#### Request Headers
- **Authorization** (string) - Required - Access credential access_token. Format: `Bearer access_token`. Example: `Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51`

### Request Example
```
# Please replace the domain name according to your region
curl --location 'https://openapi.orionstar.com/v1/corp/map_list?ov_corpid=test_ov_corpid' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
```

### Response
#### Success Response (200)
- **code** (int) - Error code. 0 is success, non-0 is failure. Please refer to Error Codes.
- **msg** (string) - Error description. When it fails, a specific error description will be given.
- **req_id** (string) - Log tracking ID. If you need Orionstar's help to troubleshoot issues, please provide this tracking ID value.
- **data** (object) - Business data data object, see data object in Response Body below.
  - **total_count** (string) - Pagination parameter. Total number of data items.
  - **map_list** (array) - List of map information objects. Each element in this array is a map information object.
    - **map** (object) - Map information object. Please refer to map - Robot Map Information Object.
      - **map_id** (string) - Map ID.
      - **map_name** (string) - Map name.
      - **create_time** (string) - Creation time, integer timestamp, in seconds.
      - **update_time** (string) - Last modification time, integer timestamp, in seconds.

#### Response Example
```json
{
    "code": 0,
    "msg": "",
    "data": {
        "total_count": "1",
        "map_list" : [
            {
                "map" : {
                    "map_id": "test_id",
                    "map_name": "测试地图-0107152028",
                    "create_time": "1547021774",
                    "update_time": "1562222558"
                }
            },
            // ... other map information
        ]
    }
}
```
```
Tokens:
Raw