Tencent Cloud

Prev Next

请输入关键字

Recent Pages

文档

Download PDF

DescribeRoomInfo

最后更新时间：2024-03-11 11:06:35

下载PDF

1. API Description

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

This API (the old DescribeRoomInformation) is used to query the rooms of an application (SDKAppID) in the last 14 days. Up to 100 records can be returned per call (10 are returned by default).
Note:

You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.
If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://trtc.io/document/54481

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: DescribeRoomInfo.
Version	Yes	String	Common Params. The value used for this API: 2019-07-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou, ap-mumbai, ap-singapore, na-toronto.
SdkAppId	Yes	Integer	The application ID, such as `1400xxxxxx`.
StartTime	Yes	Integer	The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`. Note: Only data in the last 14 days can be queried.
EndTime	Yes	Integer	The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`. Note: The end and start time cannot be more than 24 hours apart.
RoomId	No	String	The room ID, such as `223`.
PageNumber	No	Integer	The page number. The default is 0. Note: If `PageNumber` or `PageSize` is not specified, 10 records will be returned.
PageSize	No	Integer	The number of records per page. The default is `10`. Value range: 1-100.

3. Output Parameters

Parameter Name	Type	Description
Total	Integer	The number of records returned.
RoomList	Array of RoomState	The room information.
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 Querying the room list of an application (`SDKAppID`)

Input Example

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

{
    "StartTime": 1590065777,
    "SdkAppId": 1400353843,
    "EndTime": 1590065877,
    "PageNumber": 0,
    "PageSize": 10
}

Output Example

{
    "Response": {
        "Total": 10,
        "RoomList": [
            {
                "CommId": "1400188366_563398783_1587959355",
                "RoomString": "113a730673fee2d86e93e26cddb25b7d",
                "CreateTime": 1587959355,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "mixer_113a730673fee2d86e93e26cddb25b7d"
            },
            {
                "CommId": "1400188366_3791597063_1587959341",
                "RoomString": "4724f5b26c36bd53ea139e7e1c3dea1e",
                "CreateTime": 1587959341,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "mixer_4724f5b26c36bd53ea139e7e1c3dea1e"
            },
            {
                "CommId": "1400188366_15343445_1587731480",
                "RoomString": "ae4e2ebc3a71d5b151efca3e1dbe32e9",
                "CreateTime": 1587731480,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "mixer_ae4e2ebc3a71d5b151efca3e1dbe32e9"
            },
            {
                "CommId": "1400188366_1100067693_1587730962",
                "RoomString": "f83dec1f40adaf92117b62d6f9e7e0b4",
                "CreateTime": 1587730962,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "mixer_f83dec1f40adaf92117b62d6f9e7e0b4"
            },
            {
                "CommId": "1400188366_2420034035_1587723604",
                "RoomString": "76f067dfad1044171dad37bf65b1cf4b",
                "CreateTime": 1587723604,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "mixer_76f067dfad1044171dad37bf65b1cf4b"
            },
            {
                "CommId": "1400188366_2420034035_1587713998",
                "RoomString": "76f067dfad1044171dad37bf65b1cf4b",
                "CreateTime": 1587713998,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "mixer_76f067dfad1044171dad37bf65b1cf4b"
            },
            {
                "CommId": "1400188366_3501_1586952940",
                "RoomString": "3501",
                "CreateTime": 1586952940,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "yuting"
            },
            {
                "CommId": "1400188366_3015068783_1586952940",
                "RoomString": "7651c9da1253981c8b842bcdcad11c3e",
                "CreateTime": 1586952940,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "7651c9da1253981c8b842bcdcad11c3e"
            },
            {
                "CommId": "1400188366_3501_1586952865",
                "RoomString": "3501",
                "CreateTime": 1586952865,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "yuting"
            },
            {
                "CommId": "1400188366_3015068783_1586952865",
                "RoomString": "7651c9da1253981c8b842bcdcad11c3e",
                "CreateTime": 1586952865,
                "DestroyTime": 1588040628,
                "IsFinished": false,
                "UserId": "7651c9da1253981c8b842bcdcad11c3e"
            }
        ],
        "RequestId": "83ca6fdd-cf4c-46a9-a577-74c3497ad3fa"
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError	Internal error.
InternalError.DBError	An error occurred while querying the database.
InternalError.EsQueryError	An error occurred during an ES query.
InternalError.HttpParaseFalied	Failed to parse the HTTP request.
InternalError.InterfaceErr	API error.
InternalError.MethodErr	Unsupported method.
InvalidParameter.BodyParamsError	Failed to parse body parameters.
InvalidParameter.EndTs	Invalid `EndTs`.
InvalidParameter.PageNumber	Invalid `PageNumber`.
InvalidParameter.PageSize	Invalid `PageSize`.
InvalidParameter.PageSizeOversize	The value of `PageSize` exceeds 100.
InvalidParameter.QueryScaleOversize	The query period exceeds the limit.
InvalidParameter.SdkAppId	`SdkAppId` is incorrect.
InvalidParameter.SdkAppid	Inoperable `SdkAppid`.
InvalidParameter.StartTimeOversize	The query start time exceeds the range allowed by the current dashboard edition. For details, see https://www.tencentcloud.com/document/product/647/81331?from_cn_redirect=1
InvalidParameter.StartTs	Invalid `StartTs`.
InvalidParameter.StartTsOversize	The start time for query exceeded the limit.
InvalidParameter.UrlParamsError	Failed to parse URL parameters.
InvalidParameter.UserId	Invalid `UserId`.
MissingParameter.CommIdOrSdkAppId	`SdkAppId` or `CommID` missing.
MissingParameter.EndTs	`endTS_s` is missing.
MissingParameter.RoomNum	`RoomNum` is missing.
MissingParameter.SdkAppId	`SdkAppId` is missing.
MissingParameter.StartTs	`startTS_s` is missing.

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

DescribeRoomInfo

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the room list of an application (`SDKAppID`)

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

DescribeRoomInfo

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the room list of an application (SDKAppID)

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

Example1 Querying the room list of an application (`SDKAppID`)