DescribeUserInformation

Recent Pages

Last updated: 2021-10-27 16:01:48

1. API Description

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

This API is used to query the user list of a specified time range (up to 4 hours) in the last 14 days. Data of 6 users is displayed on each page by default, and data of up to 100 users can be displayed on each page (PageSize set to 100 or smaller).
Note: You can use this API to query or check historical data, but not for real-time key business logic.

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 parameter. The value used for this API: DescribeUserInformation.
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.
CommId	Yes	String	Unique ID of a call: sdkappid_roomgString_createTime. The `roomgString` refers to the room ID, and `createTime` refers to the creation time of a room in the format of UNIX timestamp in seconds, such as 1400353843_218695_1590065777. Its value can be obtained from the `DescribeRoomInformation` API (related document: https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1).
StartTime	Yes	Integer	Query start time (s) in the format of Unix timestamp (e.g., 1590065777), 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., 1590065877)
SdkAppId	Yes	String	`SDKAppID` of the users to query, e.g., 1400353843
UserIds.N	No	Array of String	The array of user IDs for query. You can enter up to 6 user IDs. If it is left empty, data of 6 users will be returned.
PageNumber	No	String	Page index starting from 0. If either `PageNumber` or `PageSize` is left empty, 6 data entries will be returned.
PageSize	No	String	Number of entries per page. If either `PageNumber` or `PageSize` is left empty, 6 data entries will be returned. `PageSize` is up to 100.

3. Output Parameters

Parameter Name	Type	Description
Total	Integer	Total number of users whose information will be returned
UserList	Array of UserInformation	User information list Note: this field may return `null`, indicating that no valid value was found.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying users and call metrics

Input Example

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

{
    "StartTime": 1590065777,
    "CommId": "1400353843_218695_1590065777",
    "UserIds": [
        "user1_54816741",
        "user2_2107025"
    ],
    "SdkAppId": "1400353843",
    "EndTime": 1590065877
}

Output Example

{
  "Response": {
    "Total": 1,
    "UserList": [
      {
        "RoomStr": "218695",
        "UserId": "user1_54816741",
        "JoinTs": 1590065777,
        "LeaveTs": 1590067658,
        "Finished": true,
        "DeviceType": "",
        "SdkVersion": "4.3.14",
        "ClientIp": "10.4.1.13"
      },
      {
        "RoomStr": "218695",
        "UserId": "user2_2107025",
        "JoinTs": 1590065700,
        "LeaveTs": 1590067693,
        "Finished": true,
        "DeviceType": "",
        "SdkVersion": "4.3.14",
        "ClientIp": "10.4.1.13"
      }
    ],
    "RequestId": "2e12e365-43e8-4efd-902d-906303e2ee4a"
  }
}

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.HttpParaseFalied	Failed to parse the HTTP request.
InternalError.InterfaceErr	API error.
InternalError.MethodErr	Unsupported method.
InvalidParameter	Invalid parameter.
InvalidParameter.BodyParamsError	Failed to parse the body parameter.
InvalidParameter.EncodeParams	Invalid `EncodeParams`.
InvalidParameter.PageSize	Invalid `PageSize`.
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.
MissingParameter	Missing parameter.
MissingParameter.CommId	`CommId` is missing.
MissingParameter.EndTs	`endTS_s` is missing.
MissingParameter.SdkAppId	`SdkAppId` is missing.
MissingParameter.StartTs	`startTS_s` is missing.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Tencent Cloud Partner Network

Become a Partner

International Partner Academy

Recent Pages