查询席位容量与分配接口

读取组织订阅的席位总数、已分配数量和可用数量。返回的是组织席位汇总,不包含逐个用户的席位分配记录。

所需权限

所需权限资源Scope资源服务
用户与部门信息读取(读取)user-directoryadmin.v1.user-directory.readqwenwork-biz-service

GET /api/openapi/v1/seats

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。

名称位置类型必填说明示例
Authorizationheaderstring应用 API Key,使用 Bearer 方式传递。Bearer qwk_\\*
X-Request-Idheaderstring可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

此接口没有额外请求参数。

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request GET --url '<BASE_URL>/api/openapi/v1/seats' --header 'Authorization: Bearer <API_KEY>'

响应

200 请求成功,返回当前或更新后的数据。

名称类型必填说明示例
assigned_seatsinteger · int64已分配给用户的席位数量。0
available_seatsinteger · int64组织当前仍可分配的席位数量。0
data_as_ofstring · date-time本次数据对应的时间,用于判断数据的新鲜程度。"2026-08-27T10:00:00Z"
data_statusstring数据状态:fresh 为新鲜数据,stale 表示返回了旧数据。"fresh"
total_seatsinteger · int64组织订阅提供的席位总数。0
updated_atstring · date-time此记录最后一次更新的时间。"2026-08-27T10:00:00Z"
{
  "assigned_seats": 0,
  "available_seats": 0,
  "data_as_of": "2026-08-27T10:00:00Z",
  "data_status": "fresh",
  "total_seats": 0,
  "updated_at": "2026-08-27T10:00:00Z"
}

default 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}