tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRoomStatistics

Last updated: 2024-04-01 19:34:23

    1. API Description

    Domain name for API request: lcic.tencentcloudapi.com.

    This API is used to obtain the statistics of a room. It can be called only after the room is ended.
    A maximum of 20 requests can be initiated per second for this API.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeRoomStatistics.
    Version Yes String Common Params. The value used for this API: 2022-08-17.
    Region No String Common Params. This parameter is not required.
    RoomId Yes Integer Room ID
    Page Yes Integer Current page in pagination, which starts from 1.
    Limit Yes Integer Number of data entries to return per page. Maximum value: 1000

    3. Output Parameters

    Parameter Name Type Description
    PeakMemberNumber Integer Peak number of online members
    MemberNumber Integer Accumulated number of online members
    Total Integer Total number of records, including members who entered the room and members who should attend the class but did not
    MemberRecords Array of MemberRecord Member record list
    RealStartTime Integer The actual start time of the room, in Unix timestamp, accurate to seconds. Note: This field may return null, indicating that no valid values can be obtained.
    RealEndTime Integer The actual end time of the room, in Unix timestamp, accurate to seconds. Note: This field may return null, indicating that no valid values can be obtained.
    MessageCount Integer The total message count of the room.
    MicCount Integer The total number of mic-on students in the room.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Getting the statistics of a room

    This example shows you how to get the statistics of a room.

    Input Example

    POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoomStatistics
<Common request parameters>

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

    Output Example

    {
    "Response": {
        "PeakMemberNumber": 1,
        "MemberNumber": 1,
        "Total": 1,
        "MemberRecords": [
            {
                "UserId": "xx",
                "UserName": "xx",
                "PresentTime": 1,
                "Camera": 1,
                "Mic": 1,
                "Silence": 1,
                "AnswerQuestions": 1,
                "HandUps": 1,
                "FirstJoinTimestamp": 1,
                "LastQuitTimestamp": 1,
                "Rewords": 1,
                "IPAddress": "xx",
                "Location": "xx",
                "Device": 0
            }
        ],
        "RealStartTime": 1,
        "RealEndTime": 1,
        "MessageCount": 1,
        "MicCount": 1,
        "RequestId": "xx"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.RoomNotEnd The class has not ended.
    InternalError Internal error.
    ResourceNotFound.Room The room does not exist.
    ResourceUnavailable.RoomStatistics Getting room data. Please wait.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy