千问办公企业旗舰版开发者文档:读取事件历史。
认证方式见APP开发者文档 → 认证接入。
媒体类型:
创建会话绑定当前IAM用户;资源读取与变更按用户归属校验。写入发生超时或响应丢失时,不应假定服务端未接纳并盲目重复请求。
- 模块:会话服务(session)
- 接口:GET
/api/openapi/app/v1/sessions/{session_id}/events
请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| session_id | path | string | 是 | 创建会话接口返回的会话 ID。 |
| cursor | query | integer | 否 | 历史分页恢复位置,省略或传 0 从头读取。后续分页使用本接口返回的 next_cursor;虽与 SSE 共用序号空间,但分页游标不等同于 SSE 消息边界,恢复限制见“订阅实时事件”页。 |
| limit | query | integer | 否 | 每页返回数量。 |
响应
| HTTP | 说明 |
|---|---|
| 200 | 请求成功 |
| default | 错误响应。按 code 判断具体错误,不能仅依赖 HTTP 状态码,多种错误可能共用状态码。 |
application/json。
响应200 EventListResponse
| 字段 | 类型 | 必填 | 约束 | 契约说明 |
|---|---|---|---|---|
| has_more | boolean | 是 | — | 当前是否已有更多事件;true 时可立即继续翻页,false 表示此刻没有更多事件。 |
| items | array<Event> | 是 | — | 按 seq_id 升序排列的事件;没有后续事件时返回空数组,不为 null。空页是正常响应。 |
| next_cursor | integer | 是 | format="int64" | 本页的分页游标,用于下次 cursor 请求。空页时为 0,此时保留已有游标;不将它直接当作 SSE 的安全消息边界。 |
响应200 Event
| 字段 | 类型 | 必填 | 约束 | 契约说明 |
|---|---|---|---|---|
| created_at | string | 是 | ISO 8601 时间字符串 | 事件记录时间,ISO 8601,含微秒和时区。按 seq_id 排序,不按时间排序,存储时间可能乱序。 |
| id | string | 是 | — | 业务消息 ID;同一文本的片段和历史聚合版本可共用,用于关联与合并。 |
| method | string / null | 是 | — | type=method 时的 JSON-RPC 方法;result/error 时为 null。方法集合开放,须容忍未知值。 |
| raw | object | 是 | — | 原始 JSON-RPC 2.0 消息。session/update 载荷位于 raw.params.update,其他方法位于 raw.params,结果位于 raw.result;常用结构见“订阅实时事件”页。raw.params.sessionId 是运行时会话标识,不能用于 APP 接口;使用外层 session_id、turn_id 和序号。 |
| seq_id | integer | 是 | format="int64" | 会话内递增序号,也是当前对象覆盖的起点。历史翻页使用 next_cursor;聚合事件不能仅用起始序号推算 SSE 恢复边界。 |
| seq_ids | array<integer> | 是 | — | 该对象覆盖的序号,按升序排列。按业务 id 分组,实时片段追加,历史聚合版本替换已收到的片段,避免重复文本。序号可因过滤而跳跃,不等待所有数字填满;SSE 恢复使用已处理的消息边界 id,分页使用 next_cursor。 |
| session_id | string | 是 | — | 此事件所属的会话 ID。 |
| sub_type | string / null | 是 | — | 事件子类型:sessionUpdate 值,或回合结果的 prompt_response;无需进一步区分的方法可为 null,例如 session/request_permission。开放枚举,容忍未知值。 |
| turn_id | string / null | 是 | — | 事件所属回合。会话启动、空闲状态等回合外事件为 null。 |
| type | string | 是 | enum=["method", "result", "error"] | JSON-RPC 消息类别;结合 type、method、sub_type 分派,常用载荷见“订阅实时事件”页。 |