Skip to main content

读取首页配置

千问办公企业旗舰版开发者文档:读取首页配置。

  • 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 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。

请求参数

无请求参数。

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/personalization/configs/homepage' \
  --header 'Authorization: Bearer <API_KEY>'

响应状态表

HTTP 状态码触发条件响应结构引用客户端处理建议
200请求成功见本文“响应结果”读取响应结果。
default未单独列出的认证、授权、校验或依赖错误见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构按状态与 code 处理;写操作重试前核实结果及幂等要求。

响应结果

Content-Type: application/json
名称类型必填说明示例
configobject是分区配置;初始值为 {}-
product_editionstring否产品部署版本类型; enum=["vpc", "k8s"] 取值:"k8s"、"vpc"-
publication_idstring | null是发布记录 ID;尚未发布时为 null-
published_atstring · date-time | null是发布时间;尚未发布时为 null; format="date-time"-
revisioninteger · int64是当前版本号,用于并发控制; format="int64"-
sectionstring是个性化配置分区-

config

字段类型必填说明
recommendedPromptsarray<object>否首页推荐语
visibilityobject否首页模块可见性
welcomeobject否欢迎语配置

config.recommendedPrompts[]

字段类型必填说明
categorystring否推荐语分类
createdAtstring否创建时间
createdByEmailstring否创建人邮箱
createdByNamestring否创建人姓名
displayPromptstring否展示文案
enabledboolean否是否启用
idstring否推荐语 ID
inputPromptstring否实际输入文案
sourceRecordIdstring否来源记录 ID
updatedAtstring否更新时间
updatedByEmailstring否更新人邮箱
updatedByNamestring否更新人姓名

config.visibility

字段类型必填说明
featureSpotlightsobject否功能亮点入口
recommendedPromptsobject否首页推荐语

config.welcome

字段类型必填说明
enstring否en
withProjectobject否项目内的欢迎语
withoutProjectobject否无项目时的欢迎语
zh-CNstring否zh-CN
zh-TWstring否zh-TW

config.visibility.featureSpotlights

字段类型必填说明
visibleboolean否是否展示

config.visibility.recommendedPrompts

字段类型必填说明
visibleboolean否是否展示

config.welcome.withProject

字段类型必填说明
enstring否英文文案
zh-CNstring否简体中文文案
zh-TWstring否繁体中文文案

config.welcome.withoutProject

字段类型必填说明
enstring否英文文案
zh-CNstring否简体中文文案
zh-TWstring否繁体中文文案

错误与重试

保留现有 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 配置片段,不是完整请求或响应。
{"welcome":{"withoutProject":{"zh-CN":"{{greeting}},{{name}}","zh-TW":"{{greeting}},{{name}}","en":"{{greeting}}, {{name}}"},"withProject":{"zh-CN":"欢迎来到 {{project}}","zh-TW":"歡迎來到 {{project}}","en":"Welcome to {{project}}"}}}