实时互动-教育版获取房间统计信息-房间管理相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： lcic.tencentcloudapi.com 。

获取房间统计信息，仅可在房间结束后调用。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRoomStatistics。
Version	是	String	公共参数，本接口取值：2022-08-17。
Region	否	String	公共参数，此参数为可选参数。
RoomId	是	Integer	房间Id。示例值：1234657
Page	是	Integer	分页查询当前页数，从1开始递增。示例值：1
Limit	是	Integer	每页数据量，最大1000。示例值：10

3. 输出参数

参数名称	类型	描述
PeakMemberNumber	Integer	峰值在线成员人数。示例值：1
MemberNumber	Integer	累计在线人数。示例值：1
Total	Integer	记录总数。包含进入房间或者应到未到的。示例值：1
MemberRecords	Array of MemberRecord	成员记录列表。
RealStartTime	Integer	秒级unix时间戳，实际房间开始时间。示例值：1675677337
RealEndTime	Integer	秒级unix时间戳，实际房间结束时间。示例值：1675677337
MessageCount	Integer	房间消息总数。示例值：1
MicCount	Integer	房间连麦总数。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

获取房间统计信息示例

输入示例

POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoomStatistics
<公共请求参数>

{
    "RoomId": 1,
    "Page": 1,
    "Limit": 1
}

输出示例

{
    "Response": {
        "PeakMemberNumber": 1,
        "MemberNumber": 1,
        "Total": 1,
        "MemberRecords": [
            {
                "UserId": "90813",
                "UserName": "Name",
                "PresentTime": 1,
                "Camera": 1,
                "Mic": 1,
                "Silence": 1,
                "AnswerQuestions": 1,
                "HandUps": 1,
                "FirstJoinTimestamp": 1,
                "LastQuitTimestamp": 1,
                "Rewords": 1,
                "IPAddress": "1.1.1.1",
                "Location": "country",
                "Device": 0,
                "PerMemberMicCount": 0,
                "PerMemberMessageCount": 0,
                "Role": 1,
                "GroupId": "2CvDgjRNjylAs",
                "SubGroupId": [
                    "BZB4iZc0F6ko"
                ],
                "Stage": 0,
                "CurrentState": 1
            }
        ],
        "RealStartTime": 1,
        "RealEndTime": 1,
        "MessageCount": 1,
        "MicCount": 1,
        "RequestId": "e574aae1-lp02-4225-a2f8-9032h7199f5f0"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.ClassExpired	房间状态错误，房间已过期。
FailedOperation.RoomNotEnd	房间暂未结束。
InternalError	内部错误。
ResourceNotFound.Room	房间不存在。
ResourceUnavailable.RoomStatistics	房间统计结果计算中，请稍候。

获取房间统计信息

本页目录：