千问办公官方帮助中心(阿里云)
读取组织的敏感词库,查看名称、词条和启用状态。可先取得词库标识,再更新词条或删除词库。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
| 敏感词库读取(读取) | sensitive-words | admin.v1.sensitive-words.read | qwenwork-biz-service |
HELPCODEESCAPE-http
GET /api/openapi/v1/sensitive-word-libraries认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\*\*\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
| 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/sensitive-word-libraries?page=1&page_size=20' \
--header 'Authorization: Bearer <API_KEY>'响应
200 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
| items | array \| null | 是 | 符合查询条件的当前页记录列表。 | \[\{"created_at":"2026-08-27T10:00:00Z","description":"\<string\>","enabled":false,"id":"\<string\>","keywords":\["\<string\>"\],"name":"\<string\>","updated_at":"2026-08-27T10:00:00Z"\}\] |
| items\[\].created_at | string · date-time | 是 | 此记录的创建时间。 | "2026-08-27T10:00:00Z" |
| items\[\].description | string | 是 | 敏感词库的用途说明。 | "\<string\>" |
| items\[\].enabled | boolean | 是 | 是否启用这项配置。 | false |
| items\[\].id | string | 是 | 此记录的唯一标识,查询、更新或删除对应记录时使用。 | "\<string\>" |
| items\[\].keywords | array \| null | 是 | 敏感词库中的词条列表。 | \["\<string\>"\] |
| items\[\].name | string | 是 | 敏感词库的名称。 | "\<string\>" |
| items\[\].updated_at | string · date-time | 是 | 此记录最后一次更新的时间。 | "2026-08-27T10:00:00Z" |
| page | integer · int64 | 是 | 当前结果页的页码,从 1 开始。 | 0 |
| page_size | integer · int64 | 是 | 每页返回的记录数。 | 0 |
| total_items | integer · int64 | 是 | 符合查询条件的记录总数。 | 0 |
| total_pages | integer · int64 | 是 | 按当前每页数量计算的总页数。 | 0 |
HELPCODEESCAPE-json
{
"items": [
{
"created_at": "2026-08-27T10:00:00Z",
"description": "<string>",
"enabled": false,
"id": "<string>",
"keywords": [
"<string>"
],
"name": "<string>",
"updated_at": "2026-08-27T10:00:00Z"
}
],
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 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>"
}