Skip to main content

创建登录背景上传会话

千问办公企业旗舰版开发者文档:创建登录背景上传会话。

  • Scope: admin.v1.personalization.manage
  • 权限项: 个性化配置管理
  • 权限类型: manage
  • 接口: POST/api/openapi/v1/personalization/login-background-upload-sessions
使用 Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。各 Scope 独立授权。响应不应缓存。 此上传会话用于更换组织登录页的背景图片。创建会话时提供 Idempotency-Key、media_type 和 size_bytes,按返回的 URL、方法及请求头直传文件。图片须为 PNG 或 JPEG,最大 5 MiB,尺寸至少 720×720。会话绑定组织与上传者。上传完成后,通过「发布登录页配置」接口提交 config.backgroundUploadId,背景才会生效。

公共请求头

适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。

请求参数

请求体:必填;Content-Type:application/json。
名称位置类型必填说明示例
Idempotency-Keyheaderstring是幂等键; maxLength=255-
media_typebodystring是media type; enum=["image/png", "image/jpeg"] 取值:"image/jpeg"、"image/png"-
size_bytesbodyinteger · int64是文件大小,单位为字节; format="int64", minimum=1, maximum=5242880-

请求示例

curl --request POST \
  --url 'https://example.invalid/api/openapi/v1/personalization/login-background-upload-sessions' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
  "media_type": "image/png",
  "size_bytes": 1
}'

响应状态表

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

响应结果

Content-Type: application/json
名称类型必填说明示例
max_size_bytesinteger · int64是允许的最大文件大小,单位为字节; format="int64"-
upload_headersobject是上传时需要携带的请求头-
upload_idstring是上传会话 ID-
upload_methodstring是上传使用的 HTTP 方法-
upload_urlstring · uri是文件上传地址; format="uri"-
upload_url_expires_atstring · date-time是上传地址的过期时间; format="date-time"-

错误与重试

保留现有 UI 服务的错误码与校验。401/403 表示认证或授权失败;409 表示冲突,应重新读取后重试;413 表示请求过大;400/422 表示参数校验失败;503 表示依赖不可用。以实际响应及机器契约为准。创建类幂等操作重试应使用相同 Idempotency-Key 与相同请求。