Get Robot List
Overview
- This API is used to get the list of robots;
Authorization
| 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
Request Entry Point
| Region | Entry Point |
|---|---|
| China Region | https://openapi.orionstar.com |
| Europe Region | https://global-openapi.orionstar.com |
| USA Region | https://us-openapi.orionstar.com |
| Japan Region | https://jp-openapi.orionstar.com |
Request Protocol
| HTTP URL Path | /v1/robot/robot_list |
|---|---|
| HTTP Method | GET |
Request URL Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| ov_corpid | string | Yes | Enterprise ID. Multiple enterprise IDs should be separated by commas. |
| robot_sn | string | No | Robot SN. If this parameter is passed, only the corresponding robots will be returned. Multiple SNs should be separated by commas. |
| page | int | No | Paging parameter. The current page number, starting from 1, defaults to 1. |
| page_rows | int | No | Paging parameter. How many data items per page, default is 1. |
Request cURL Example
# Please replace the entry point with yours according to your region curl --location 'https://global-openapi.orionstar.com/v1/robot/robot_list?ov_corpid=test_ov_corpid' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
Response
Common Response Body
| 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. |
Response Body Data Object
| Parameter | Type | Description |
|---|---|---|
| total_count | string | Paging parameter. The total number of data items. |
| robot_list | array | Robot information list data, where each element in this array is a robot robot information object. Please refer to robot - Robot Information Object. |
robot - Robot Information Object
| Parameter | Type | Description |
|---|---|---|
| ov_corpid | string | enterprise ID |
| robot_uuid | string | Robot UUID |
| robot_sn | string | Robot SN |
| robot_name | string | Robot name |
| robot_version | string | Robot ROM version, for example: V9.7.2024041200.1234US |
| robot_model | string | Robot model, for example: OS-R-DR01S |
| bind_time | string | Last time the robot was bound to the current enterprise. Integer timestamp in seconds. For example: 1711966681. |
| expires_time | string | Expiry time of the lease, valid only for leased robots. Integer timestamp in seconds. For example: 1711966681. |
| online_status | string | Robot online status. Online status is determined based on the heartbeats sent by the robot, with updates having approximately a 15-second delay. 0: Offline 1: Online. |
Response Body Example
{ "code": 0, "msg": "", "data": { "total_count": "10", "robot_list": [ { "ov_corpid": "orion.ovs.entprise.12345678", "robot_uuid": "test_uuid", "robot_sn": "test_sn", "robot_name": "test_name", "robot_version": "V9.7.2024041200.1234US", "robot_model": "OS-R-DR01S", "bind_time": "1711966681", "online_status": "1" }, // ... Omitted 9 other robot information objects ] } }