切换主题
查询任务关联机器人变量列表接口
用于查询指定任务所使用的机器人下,关联的全部变量列表
GEThttps://dashboard.avavox.com/open/api/task/{taskId}/robot-variables
请求头
Authorization string 必填
- 填写格式:
Authorization: Bearer <App Key> <App Key>为控制台「App Key 管理」页面生成的 Key。- 获取方式详见:《App Key 创建与管理》。
Path 参数
taskId string 必填
需要查询的任务ID
响应数据
code int
状态码,200 为成功,其他状态均为失败。
success boolean
是否成功,true 表示成功,false 表示失败。
message string
描述信息
data object
任务详情数据,结构如下:
点击展开字段说明
robotId string
机器人 ID。
robotName string
机器人名称
variables array
变量列表
点击展开字段说明
name string
变量名称
key string
变量key
description string
变量描述信息
defaultValue string
变量默认值
required boolean
变量是否必填,true-必填,false-非必填
category string
变量类型
custom:自定义变量system:系统变量
请求示例
shell
curl --location 'https://dashboard.avavox.com/open/api/task/123/robot-variables' \
--header 'Authorization: Bearer $Key' \
--header 'Content-Type: application/json'响应示例
json
{
"code": 200,
"message": "操作成功",
"success": true,
"data": {
"robotId": "机器人ID",
"robotName": "机器人名称",
"variables": [
{
"name": "变量名称",
"key": "变量key",
"description": "变量描述信息",
"defaultValue": "变量默认值",
"required": true,
"category": "custom"
}
]
}
}