千问办公官方帮助中心(阿里云)
查询当前应用可访问的组织用户,按关键词、部门、账号状态和席位状态筛选。返回用户标识 qid、基本资料、部门归属及席位状态,可用于定位后续需要修改的用户。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
| 用户与部门信息读取(读取) | user-directory | admin.v1.user-directory.read | qwenwork-biz-service |
HELPCODEESCAPE-http
GET /api/openapi/v1/users认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\*\*\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
| keyword | query | string | 否 | 用于筛选此列表的搜索关键词。 | "\<string\>" |
| department_id | query | string · uuid | 否 | 按用户所属部门筛选,填写部门标识。 | "\<uuid\>" |
| status | query | string | 否 | 只返回此状态的记录;不填写时不按状态筛选。 | "pending" |
| seat_status | query | string | 否 | 席位状态筛选:assigned 为已分配,unassigned 为未分配。 | "assigned" |
| page | query | integer · int64 | 否 | 请求的页码,从 1 开始。 默认值:1。 最小值:1。 | 1 |
| page_size | query | integer · int64 | 否 | 每页返回的记录数量。 默认值:20。 最小值:1。 最大值:100。 | 20 |
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
HELPCODEESCAPE-text
curl --request GET \
--url '<BASE_URL>/api/openapi/v1/users?keyword=<keyword>&department_id=<department_id>&status=<status>&seat_status=<seat_status>&page=1&page_size=20' \
--header 'Authorization: Bearer <API_KEY>'响应
200 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
| items | array \| null | 是 | 符合查询条件的当前页记录列表。 | \[\{"account":"\<string\>","department_ids":\["\<string\>"\],"email":"\<string\>","job_number":"\<string\>","name":"\<string\>","phone":"\<string\>","qid":"\<uuid\>","seat_status":"assigned","source":"manual","status":"pending","updated_at":"2026-08-27T10:00:00Z"\}\] |
| items\[\].account | string | 否 | 用户的登录账号。 | "\<string\>" |
| items\[\].department_ids | array \| null | 是 | 用户所属部门的标识列表。 | \["\<string\>"\] |
| items\[\].email | string | 否 | 用户的邮箱地址。 | "\<string\>" |
| items\[\].job_number | string | 否 | 企业为用户分配的工号。 | "\<string\>" |
| items\[\].name | string | 是 | 用户的姓名。 | "\<string\>" |
| items\[\].phone | string | 否 | 用户的电话号码。 | "\<string\>" |
| items\[\].qid | string · uuid | 是 | 用户在千问办公中的唯一标识,用户更新和删除接口使用此值。 | "\<uuid\>" |
| items\[\].seat_status | string | 是 | 用户的席位状态:assigned 为已分配,unassigned 为未分配。 | "assigned" |
| items\[\].source | string | 是 | 用户来源:manual 为手动管理,directory-sync 为通讯录同步。 | "manual" |
| items\[\].status | string | 是 | 账号状态:pending 为待激活,active 为已激活,disabled 为已禁用。 | "pending" |
| items\[\].updated_at | string · date-time | 是 | 此记录最后一次更新的时间。 | "2026-08-27T10:00:00Z" |
| page | integer · int64 | 是 | 当前结果页的页码,从 1 开始。 | 0 |
| page_size | integer · int64 | 是 | 每页返回的记录数。 | 0 |
| total | integer · int64 | 是 | 符合查询条件的记录总数。 | 0 |
HELPCODEESCAPE-json
{
"items": [
{
"account": "<string>",
"department_ids": [
"<string>"
],
"email": "<string>",
"job_number": "<string>",
"name": "<string>",
"phone": "<string>",
"qid": "<uuid>",
"seat_status": "assigned",
"source": "manual",
"status": "pending",
"updated_at": "2026-08-27T10:00:00Z"
}
],
"page": 0,
"page_size": 0,
"total": 0
}default 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
| code | string | 否 | 用于程序判断错误原因的稳定业务错误码。 | "\<string\>" |
| detail | string | 是 | 便于阅读的错误说明。 | "\<string\>" |
| details | OpenapiErrorDetails | 否 | 字段校验失败时的详细信息。 | \{"field":"\<string\>","reason":"\<string\>","suggestion":"\<string\>"\} |
| details.field | string | 否 | 未通过校验的请求字段。 | "\<string\>" |
| details.reason | string | 否 | 稳定的校验失败原因,用于判断字段为何不合法。 | "\<string\>" |
| details.suggestion | string | 否 | 建议采用的规范化字段值。 | "\<string\>" |
| error | string | 是 | 稳定的 HTTP 错误类型。 | "\<string\>" |
HELPCODEESCAPE-json
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}