製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
Domain name for API request: trtc.intl.tencentcloudapi.com.
This API (the old DescribeUserInformation) is used to query the user list of a specified time range (up to four hours) in the last 14 days. The data of up to 100 users can be returned per page (six are returned by default).
Note:
A maximum of 20 requests can be initiated per second for this API.
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: DescribeUserInfo. |
| 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. |
| CommId | Yes | String | The unique ID of a call, whose format is SdkAppId_CreateTime, such as 1400xxxxxx_218695_1590065777. createTime is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the DescribeRoomInfo API. |
| 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 four hours apart. |
| SdkAppId | Yes | Integer | The application ID, such as 1400xxxxxx. |
| UserIds.N | No | Array of String | The users to query. If you do not specify this, the information of six users will be returned. Array length: 1-100. |
| PageNumber | No | Integer | The page number. The default is 0. Note: If PageNumber or PageSize is not specified, six records will be returned. |
| PageSize | No | Integer | The number of records per page. The default is 6.Array length: 1-100. |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | The number of records returned. |
| UserList | Array of UserInformation | The user information. Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserInfo
<Common request parameters>
{
"StartTime": 1590065777,
"CommId": "1400188366_218695_1590065777",
"UserIds": [
"user1_54816741",
"user2_2107025"
],
"SdkAppId": 1400188366,
"EndTime": 1590065877
}{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Parameter error. |
| InvalidParameter.BodyParamsError | Failed to parse body parameters. |
| InvalidParameter.EncodeParams | Invalid EncodeParams. |
| 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.UserIdsMorethanSix | The number of users exceeds 6. |
| MissingParameter | Missing parameter. |
| MissingParameter.CommId | CommId is missing. |
| MissingParameter.CommIdOrSdkAppId | SdkAppId or CommID missing. |
| MissingParameter.EndTs | endTS_s is missing. |
| MissingParameter.SdkAppId | SdkAppId is missing. |
| MissingParameter.StartTs | startTS_s is missing. |
フィードバック