Skip to main content

查询会话列表

千问办公企业旗舰版开发者文档:查询会话列表。

认证方式见APP开发者文档 → 认证接入。
  • 模块:会话服务(session)
  • 接口:GET/api/openapi/app/v1/sessions

请求参数

参数位置类型必填说明
namequerystring否当前用户会话名称的不区分大小写字面子串;去除首尾空白,最多 256 字符,不支持通配符。可与分页及其他筛选组合。
statusquerystring否仅返回指定状态的会话;action_required 表示等待用户回应。
updated_sincequerystring否RFC3339 时间戳,仅返回该时刻之后发生更新的会话。
cursorqueryinteger否分页游标,不解析其内部含义;首次请求省略。
limitqueryinteger否每页返回数量。

响应

HTTP说明
200请求成功
default错误响应。按 code 判断具体错误,不能仅依赖 HTTP 状态码,多种错误可能共用状态码。
媒体类型:application/json。

响应200 SessionListResponse

字段类型必填约束契约说明
has_moreboolean是—是否存在下一页;以此字段为准,不能仅根据当前页是否满额判断。
itemsarray<SessionSummary>是—会话列表,最新在前;没有会话时返回空数组,不为 null。
next_cursorinteger是format="int64"下一页请求的 cursor,没有下一页时为 0;是否继续翻页以 has_more 为准。

响应200 SessionSummary

字段类型必填约束契约说明
created_atstring是ISO 8601 时间字符串会话创建时间,ISO 8601,含微秒和时区。
end_reasonstring / null是—会话结束原因;尚未结束时为 null,仅 terminated 状态下设置。
modestring是—会话使用的能力档位。
namestring是—显示名称。
session_idstring是—会话 ID,可用于查询会话详情。
statusstring是—当前会话状态。使用 status=action_required 筛选等待用户回应的会话。
updated_atstring是ISO 8601 时间字符串会话记录最近更新时间,ISO 8601。

使用说明

创建会话绑定当前IAM用户;资源读取与变更按用户归属校验。写入发生超时或响应丢失时,不应假定服务端未接纳并盲目重复请求。