DescribeRoomInformation

最后更新时间:2021-10-27 16:01:49

1. API Description

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

This API is used to query the room list of an SDKAppID in the last 14 days. It returns 10 calls by default and can return up to 100 calls per query.
Note: You can use this API to query or check historical data, but not for real-time key business logic.

A maximum of 200 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 parameter. The value used for this API: DescribeRoomInformation.
Version Yes String Common parameter. The value used for this API: 2019-07-22.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
SdkAppId Yes String User sdkappid
StartTime Yes Integer Query start time (s) in the format of Unix timestamp (e.g., 1588031999), which must be a time point in the last 14 days
EndTime Yes Integer Query end time (s) in the format of Unix timestamp, e.g., 1588034999
RoomId No String Room ID in string type
PageNumber No String Page index starting from 0 (if either PageNumber or PageSize is left empty, 10 data entries will be returned by default)
PageSize No String Number of entries per page (if either PageNumber or PageSize is left empty, 10 data entries will be returned by default. Maximum value: 100)

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of data entries displayed on the current page
RoomList Array of RoomState Room information list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the room list under a specified SdkAppId

Input Example

https://trtc.tencentcloudapi.com/?Action=DescribeRoomInformation
&StartTime=1588031999
&EndTime=1588034999
&SdkAppId=1400188366
&<Common request parameters>

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

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 while querying ES.
InternalError.HttpParaseFalied Failed to parse the HTTP request.
InternalError.InterfaceErr API error.
InternalError.MethodErr Unsupported method.
InvalidParameter.BodyParamsError Failed to parse the body parameter.
InvalidParameter.EndTs Invalid EndTs.
InvalidParameter.PageNumber Invalid PageNumber.
InvalidParameter.PageSize Invalid PageSize.
InvalidParameter.PageSizeOversize The value of PageSize exceeds 100.
InvalidParameter.QueryScaleOversize The range for query exceeded the limit.
InvalidParameter.SdkAppId SdkAppId is incorrect.
InvalidParameter.SdkAppid Inoperable SdkAppid.
InvalidParameter.StartTs Invalid StartTs.
InvalidParameter.StartTsOversize The start time for query exceeded the limit.
InvalidParameter.UrlParamsError Failed to parse the URL parameter.
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.