千问办公企业旗舰版开发者文档:读取首页配置。
- Scope:
admin.v1.personalization.read - 权限项: 个性化配置读取
- 权限类型: read
- 接口: GET
/api/openapi/v1/personalization/configs/homepage
Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。各 Scope 独立授权。响应不应缓存。
复用 UI 个性化服务。发布是整段配置替换,必须携带当前 expected_revision;版本冲突返回 409。更新首页欢迎语时应先读取并保留首页的其他字段。登录背景采用独立上传会话:提交 media_type 和 size_bytes,按返回的 URL、方法及请求头直传文件,然后在登录 config.backgroundUploadId 中引用 upload_id 并发布。PNG/JPEG 最大 5 MiB、至少 720×720;会话绑定组织与上传者。登录背景会话要求 Idempotency-Key。此组旧分区接口覆盖 login、homepage、input-placeholder。按策略组保存配置请使用 policy-groups 接口。
公共请求头
适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。
请求参数
无请求参数。
请求示例
响应状态表
| HTTP 状态码 | 触发条件 | 响应结构引用 | 客户端处理建议 |
|---|---|---|---|
200 | 请求成功 | 见本文“响应结果” | 读取响应结果。 |
default | 未单独列出的认证、授权、校验或依赖错误 | 见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构 | 按状态与 code 处理;写操作重试前核实结果及幂等要求。 |
响应结果
Content-Type: application/json
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
config | object | 是 | 分区配置;初始值为 {} | - |
product_edition | string | 否 | 产品部署版本类型; enum=["vpc", "k8s"] 取值:"k8s"、"vpc" | - |
publication_id | string | null | 是 | 发布记录 ID;尚未发布时为 null | - |
published_at | string · date-time | null | 是 | 发布时间;尚未发布时为 null; format="date-time" | - |
revision | integer · int64 | 是 | 当前版本号,用于并发控制; format="int64" | - |
section | string | 是 | 个性化配置分区 | - |
config
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
recommendedPrompts | array<object> | 否 | 首页推荐语 |
visibility | object | 否 | 首页模块可见性 |
welcome | object | 否 | 欢迎语配置 |
config.recommendedPrompts[]
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
category | string | 否 | 推荐语分类 |
createdAt | string | 否 | 创建时间 |
createdByEmail | string | 否 | 创建人邮箱 |
createdByName | string | 否 | 创建人姓名 |
displayPrompt | string | 否 | 展示文案 |
enabled | boolean | 否 | 是否启用 |
id | string | 否 | 推荐语 ID |
inputPrompt | string | 否 | 实际输入文案 |
sourceRecordId | string | 否 | 来源记录 ID |
updatedAt | string | 否 | 更新时间 |
updatedByEmail | string | 否 | 更新人邮箱 |
updatedByName | string | 否 | 更新人姓名 |
config.visibility
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
featureSpotlights | object | 否 | 功能亮点入口 |
recommendedPrompts | object | 否 | 首页推荐语 |
config.welcome
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
en | string | 否 | en |
withProject | object | 否 | 项目内的欢迎语 |
withoutProject | object | 否 | 无项目时的欢迎语 |
zh-CN | string | 否 | zh-CN |
zh-TW | string | 否 | zh-TW |
config.visibility.featureSpotlights
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
visible | boolean | 否 | 是否展示 |
config.visibility.recommendedPrompts
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
visible | boolean | 否 | 是否展示 |
config.welcome.withProject
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
en | string | 否 | 英文文案 |
zh-CN | string | 否 | 简体中文文案 |
zh-TW | string | 否 | 繁体中文文案 |
config.welcome.withoutProject
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
en | string | 否 | 英文文案 |
zh-CN | string | 否 | 简体中文文案 |
zh-TW | string | 否 | 繁体中文文案 |
错误与重试
保留现有 UI 服务的错误码与校验。401/403 表示认证或授权失败;409 表示冲突,应重新读取后重试;413 表示请求过大;400/422 表示参数校验失败;503 表示依赖不可用。以实际响应及机器契约为准。创建类幂等操作重试应使用相同 Idempotency-Key 与相同请求。
config.welcome 字段与校验边界
welcome.withoutProject(无项目)和 welcome.withProject(项目内)各为包含 zh-CN、zh-TW、en 字符串的对象。UI 每种语言最多 160 个显示单元、2 行;{{name}}、{{project}}、{{greeting}} 分别算一个显示单元。缺省内容来自 UI 本地化文案;旧版扁平 welcome 仍由 UI 兼容。
这些是已有 UI 规则;服务端继续接受开放 JSON 对象,不新增上述长度或形状校验。发布整段 homepage 配置前先 GET,并保留推荐语等其他字段,不能只提交下面的片段替换完整配置。
以下仅为 config 配置片段,不是完整请求或响应。