切换主题
查询空间列表
查询当前 App Key 可访问的空间列表,用于获取空间账单、机器人账单、任务账单接口中 spaceIds 参数所需的空间 ID。
GEThttps://dashboard.avavox.com/open/api/v1/spaces
权限说明
授权范围为「全部空间」的 Key 返回企业下的全部空间;授权范围为「仅当前空间」的 Key 只返回其绑定的那一个空间。
请求头
Authorization string 必填
- 填写格式:
Authorization: Bearer <App Key> <App Key>为控制台「App Key 管理」页面生成的 Key。- 获取方式详见:《App Key 创建与管理》。
请求参数
page int 可选
页码,从 1 开始,默认 1。
pageSize int 可选
每页条数,默认 20,最大 100。
响应数据
code int
状态码,200 为成功,其他状态均为失败。
success boolean
是否成功,true 表示成功,false 表示失败。
message string
描述信息。
data object
点击展开字段说明
total int
可访问的空间总数。
list array
空间列表,元素结构:spaceId(空间 ID)、spaceName(空间名称)。
请求示例
shell
curl -X GET --location 'https://dashboard.avavox.com/open/api/v1/spaces' \
--header 'Authorization: Bearer $Key'响应示例
json
{
"code": 200,
"message": "操作成功",
"success": true,
"data": {
"total": 4,
"list": [
{ "spaceId": "sp_default", "spaceName": "默认空间" },
{ "spaceId": "sp_001", "spaceName": "花花" },
{ "spaceId": "sp_002", "spaceName": "同道精英" },
{ "spaceId": "sp_003", "spaceName": "保全" }
]
}
}