机器人多层级配置管理
概述
- 此 API 用于管理机器人多层级配置;
- 除特殊说明外,机器人层级的配置优先级高于企业层级的配置;
授权方式
数据维度授权 | 企业级授权 | 此 API 为企业级授权,企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。 |
---|
接口维度授权 | 默认授权 | 此 API 为默认授权,您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。 |
---|
公共请求
公共请求协议
请求域名
公共响应
公共响应体
参数 | 类型 | 参数说明 |
---|---|---|
code | int | 错误代码。200 是成功,非 200 是失败,请参考 错误代码。 |
msg | string | 错误描述,当失败的时候会给出具体的错误描述。 |
data | object | 业务数据 data 对象,详见下述 响应体 data 对象。 |
机器人多层级配置管理 API 列表
HTTP URL 路径 | 名称 |
---|---|
POST /v1/robot/rsc/set_config | 设置机器人多层级配置 |
POST /v1/robot/rsc/delete_config | 删除机器人多层级配置 |
GET /v1/robot/rsc/config_list | 获取机器人多层级配置列表 |
● 设置机器人多层级配置
请求
请求协议
公共请求协议请参考 公共请求协议
HTTP URL 路径 | /v1/robot/rsc/set_config |
---|---|
HTTP Method | POST |
Content-Type | application/x-www-form-urlencoded |
请求头
公共请求头请参考 公共请求头
请求体参数
参数 | 类型 | 必填 | 参数说明 |
---|---|---|---|
ov_corpid | string | 是 | 所属企业 id |
robot_sn | string | 否 | 机器人 sn。当 scope_type 是机器人级的时候此参数必填。只能填写 1 个 sn。 |
scope_type | string | 是 | 配置层级
|
config_name | string | 是 | 配置类型
|
config_value | jsonString | 是 | 配置数据。不同的配置类型会有不同的配置数据结构,请参考 配置数据_config_value。 |
配置数据 config_value
各配置类型(config_name)的配置数据(config_value)
配置类型 config_name | 配置数据 config_value |
---|---|
AOS 机器人自定义记忆 aos_robot_custom_memory | { "main" : "机器人记忆内容" // 机器人主记忆的内容 } |
请求 cURL 示例
# 请根据您的区域替换域名 curl --location 'https://openapi.orionstar.com/v1/robot/rsc/set_config' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'ov_corpid=test_ov_corpid' \ --data-urlencode 'robot_sn=test_sn' \ --data-urlencode 'scope_type=robot' \ --data-urlencode 'config_name=aos_robot_custom_memory' \ --data-urlencode 'config_value={"main":"机器人记忆内容"}'
响应
响应体 data 对象
公共响应体请参考 公共响应
参数 | 类型 | 参数说明 |
---|---|---|
rsc_id | string | 配置 ID |
响应体示例
{ "code": 0, "msg": "", "data": { "rsc_id": "test_id" } }
● 删除机器人多层级配置
请求
请求协议
公共请求协议请参考 公共请求协议
HTTP URL 路径 | /v1/robot/rsc/delete_config |
---|---|
HTTP Method | POST |
Content-Type | application/x-www-form-urlencoded |
请求头
公共请求头请参考 公共请求头
请求体参数
参数 | 类型 | 必填 | 参数说明 |
---|---|---|---|
rsc_id | string | 是 | 配置 id |
请求 cURL 示例
# 请根据您的区域替换域名 curl --location 'https://openapi.orionstar.com/v1/robot/rsc/delete_config' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'rsc_id=test_id'
响应
响应体示例
{ "code": 0, "msg": "", "data": { } }
● 获取机器人多层级配置列表
请求
请求协议
公共请求协议请参考 公共请求协议
HTTP URL 路径 | /v1/robot/rsc/config_list |
---|---|
HTTP Method | GET |
请求头
公共请求头请参考 公共请求头
请求 URL 参数
参数 | 类型 | 必填 | 参数说明 |
---|---|---|---|
ov_corpid | string | 是 | 所属企业 id |
robot_sn | string | 否 | 机器人 sn。当 scope_type 是机器人级的时候此参数必填。只能填写 1 个 sn。 |
scope_type | string | 是 | 配置层级。请参考 ● 设置机器人多层级配置 |
config_name | string | 是 | 配置类型。请参考 ● 设置机器人多层级配置 |
page | int | 否 | 分页参数。当前是第几页,从 1 开始,默认是 1。 |
page_rows | int | 否 | 分页参数。每页多少条数据,默认是 20。 |
请求 cURL 示例
# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/robot/rsc/config_list?ov_corpid=test_id&robot_sn=test_sn&scope_type=robot&config_name=aos_robot_custom_memory' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
响应
响应体 data 对象
公共响应体请参考 公共响应
参数 | 类型 | 参数说明 |
---|---|---|
total_count | string | 总条数 |
robot_scope_config_list | object[] | 配置对象列表数组 |
robot_scope_config_list[].rsc_id | string | 配置 ID |
robot_scope_config_list[].ov_corpid | string | 企业 ID |
robot_scope_config_list[].robot_sn | string | 机器人 sn |
robot_scope_config_list[].config_name | string | 配置类型 |
robot_scope_config_list[].config_value | object | 配置数据 |
robot_scope_config_list[].create_time | string | 创建时间,整数时间戳,单位是秒。 |
robot_scope_config_list[].update_time | string | 最后修改时间,整数时间戳,单位是秒。 |
响应体示例
{ "code": 0, "msg": "", "data": { "total_count": "1", "robot_scope_config_list": [ { "robot_scope_config": { "rsc_id": "test_id", "ov_corpid": "test_ov_corp_id" "robot_sn": "test_sn", "config_name": "aos_robot_custom_memory", "config_value": { "main": "机器人记忆内容" }, "create_time": "1755708079", "update_time": "1755708553" } } ] } }