千问办公企业旗舰版开发者文档:置顶或取消置顶会话。
认证方式见APP开发者文档 → 认证接入。
pinned 必须显式为 true 或 false。普通会话修改自身置顶;计划任务主会话修改该任务分组的置顶偏好,后续新建的同组会话也继承这一展示偏好。计划子会话不支持置顶。重复设置同一值不会切换状态。
401:入口身份无效;404:资源不存在、已删除或非本人;422:输入无效;503:所需依赖未装配或暂不可用。业务状态和审核拒绝按服务端错误体处理。 计划子会话或无有效任务关联的计划会话置顶返回400。
本接口不接受调用方传入身份来改变归属,不暴露内部 extra_data、沙箱凭据或模型 runtime 配置。写入超时后先查询实际状态,不把超时视为操作未发生。
- 模块:会话服务
- 接口:PATCH
/api/openapi/app/v1/sessions/{session_id}/pin - operationId:
pin-session
接口说明
pinned 必须显式为 true 或 false。普通会话修改自身置顶;计划任务主会话修改该任务分组的置顶偏好,后续新建的同组会话也继承这一展示偏好。计划子会话不支持置顶。重复设置同一值不会切换状态。
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| session_id (path) | string | 是 | 创建会话接口返回的会话 ID。 |
请求体
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| pinned | boolean/null | 是 | 必填布尔值;false 明确表示取消置顶。 |
成功响应
HTTP 200
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| pinned | boolean | 是 | 见接口说明 |
| session_id | string | 是 | 见接口说明 |