跳到主要内容

课堂活动日志

控制台客户端配置 · 返回值与共享类型

所有活动查询都指定 classroomId 和 eduUserId。可按时间、设备、进课尝试、分类和关系筛选。列表使用 cursor 分页。

tracks 返回时间轨道,overview 返回概览。查询 detail 时传入列表返回的活动 ID,以及查询窗口的 from、to、asOf,保持同一窗口查看证据。活动状态、错误信息及遥测完整性字段均来自服务端结果。

应用后端使用应用业务接口和应用凭证。本页描述独立的租户管理调用。

activity.list​

课堂活动列表。

GET /v1/classrooms/activity

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.activity.list(appId, input)
Pythonc.activity.list(app_id, **input)
Javac.activity.list(appId, input)
Goc.Activity.List(ctx, appID, input, &result)
PHP$c->activity->list($appId, $input)

输入:ActivityQuery。 字段放在 URL 查询参数中。

字段必填类型说明
classroomId是string课堂 ID
from否string | undefined时间范围开始,ISO 8601
to否string | undefined时间范围结束,ISO 8601
deviceId否string | undefined设备标识
attemptId否string | undefined进课尝试 ID
category否"join" | "stage" | "media" | "permission" | "message" | "whiteboard" | "tool" | "connection" | "lifecycle" | "other" | undefined活动分类
relation否"initiated" | "affected" | "observed" | "system" | "server" | undefined用户与活动的关系
eduUserId是string课堂用户 ID
cursor否string | undefined上一页返回的游标
pageSize否number | undefined单页数量

返回:ActivityPage。嵌套字段见共享类型。

activity.tracks​

课堂活动轨道。

GET /v1/classrooms/activity/tracks

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.activity.tracks(appId, input)
Pythonc.activity.tracks(app_id, **input)
Javac.activity.tracks(appId, input)
Goc.Activity.Tracks(ctx, appID, input, &result)
PHP$c->activity->tracks($appId, $input)

输入:ActivityQuery。 字段放在 URL 查询参数中。

字段必填类型说明
classroomId是string课堂 ID
from否string | undefined时间范围开始,ISO 8601
to否string | undefined时间范围结束,ISO 8601
deviceId否string | undefined设备标识
attemptId否string | undefined进课尝试 ID
category否"join" | "stage" | "media" | "permission" | "message" | "whiteboard" | "tool" | "connection" | "lifecycle" | "other" | undefined活动分类
relation否"initiated" | "affected" | "observed" | "system" | "server" | undefined用户与活动的关系
eduUserId是string课堂用户 ID
cursor否string | undefined上一页返回的游标
pageSize否number | undefined单页数量

返回:ActivityTracks。嵌套字段见共享类型。

activity.overview​

课堂活动概览。

GET /v1/classrooms/activity/overview

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.activity.overview(appId, input)
Pythonc.activity.overview(app_id, **input)
Javac.activity.overview(appId, input)
Goc.Activity.Overview(ctx, appID, input, &result)
PHP$c->activity->overview($appId, $input)

输入:ActivityQuery。 字段放在 URL 查询参数中。

字段必填类型说明
classroomId是string课堂 ID
from否string | undefined时间范围开始,ISO 8601
to否string | undefined时间范围结束,ISO 8601
deviceId否string | undefined设备标识
attemptId否string | undefined进课尝试 ID
category否"join" | "stage" | "media" | "permission" | "message" | "whiteboard" | "tool" | "connection" | "lifecycle" | "other" | undefined活动分类
relation否"initiated" | "affected" | "observed" | "system" | "server" | undefined用户与活动的关系
eduUserId是string课堂用户 ID
cursor否string | undefined上一页返回的游标
pageSize否number | undefined单页数量

返回:ActivityOverview。嵌套字段见共享类型。

activity.detail​

课堂活动详情。

GET /v1/classrooms/activity/detail

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.activity.detail(appId, input)
Pythonc.activity.detail(app_id, **input)
Javac.activity.detail(appId, input)
Goc.Activity.Detail(ctx, appID, input, &result)
PHP$c->activity->detail($appId, $input)

输入:ActivityDetailInput。 字段放在 URL 查询参数中。

字段必填类型说明
classroomId是string课堂 ID
from是string时间范围开始,ISO 8601
to是string时间范围结束,ISO 8601
asOf是string列表返回的查询截止时间
eduUserId是string课堂用户 ID
activityId是string活动 ID
cursor否string | undefined上一页返回的游标
pageSize否number | undefined单页数量

返回:ActivityDetail。嵌套字段见共享类型。