文档首页/ 实时音视频 SparkRTC/ API参考/ 数据统计分析/ 查询学生和老师同时在线时长接口
更新时间：2024-10-18 GMT+08:00
查看PDF
分享

查询学生和老师同时在线时长接口

功能介绍

查询学生和老师同时在线时长接口。

最大查询跨度1天，最大查询周期14天。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/rtc/meishubao/room/user/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

app_id

是

String

应用ID

room_id

是

String

房间ID

user_a_id

是

String

用户A的ID

user_b_id

是

String

用户B的ID

start_time

否

String

查询起始时间。日期格式按照ISO8601表示法，并使用UTC时间。

格式为：YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天，最大查询周期14天。

如果参数为空，默认查询1天数据。

end_time

否

String

结束时间。日期格式按照ISO8601表示法，并使用UTC时间。

格式为：YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天，最大查询周期14天。

如果参数为空，默认为当前时间。结束时间需大于起始时间。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识
表5 响应Body参数

参数

参数类型

描述

user_a_id

String

UserA的ID

user_b_id

String

UserB的ID

user_a_duration

Long

UserA在教室内时长，单位为秒。

user_b_duration

Long

UserB在教室内时长，单位为秒。

common_duration

Long

双方在教室内的共同时长，单位为秒。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v1/{project_id}/rtc/meishubao/room/user/detail?app_id=5f963b4c89ae1628c2568001&room_id=04a9806246a811eca26c7f45a3318511&user_a_id=c58d7ac825&user_b_id=34rt1a4

响应示例

状态码： 200

查询成功返回。

{
  "user_a_id" : "956f781d7b6",
  "user_b_id" : "3d00ea7405c",
  "user_a_duration" : 234,
  "user_b_duration" : 178,
  "common_duration" : 170
}

状态码： 400

处理失败返回

{
  "error_code" : "DATA.100011001",
  "error_msg" : "Required String parameter 'app_id' is not present"
}

状态码： 500

处理失败返回

{
  "error_code" : "DATA.100011005",
  "error_msg" : "Internal System Error"
}

状态码

状态码

描述

200

查询成功返回。

400

处理失败返回

500

处理失败返回

错误码

请参见错误码。

父主题： 数据统计分析

相关文档