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/modify_robot
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
robot jsonString 是 机器人信息对象 json 串，请参考 robot - 机器人信息对象。例如：{"robot_name":"小豹"}

robot - 机器人信息对象

参数 类型 必填 参数说明
robot_name string 否 机器人名称

请求 cURL 示例

# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/robot/modify_robot' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'robot_sn=test_sn' \
     --data-urlencode 'robot={"robot_name":"小豹"}'

响应

公共响应体

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

响应体 data 对象

参数 类型 参数说明
robot object robot 机器人信息对象，请参考 robot - 机器人信息对象。

robot - 机器人信息对象

参数 类型 参数说明
ov_corpid string 所属企业 id
robot_uuid string 机器人 uuid
robot_sn string 机器人 sn
robot_name string 机器人名称
robot_version string 机器人 ROM 版本号，例如：V9.7.2024041200.1234US
robot_model string 机器人型号，例如：OS-R-DR01S
bind_time string 最后一次绑定到当前企业的时间。整数时间戳，单位是秒。例如：1711966681。
expires_time string 租期的截止时间，仅租用的机器人有效。整数时间戳，单位是秒。例如：1711966681。
online_status string 机器人在线状态。在线状态是根据机器人发送的心跳来判断的，状态更新会有大约 15 秒的延迟。
0：不在线
1：在线。

响应体示例

{
    "code": 0,
    "msg": "",
    "data" : {
        "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"
        }
    }
}