Domain name for API request: trtc.tencentcloudapi.com.
This API is used to query detailed events of a user such as room entry/exit and video enablement/disablement during a call. It can query data for the last 5 days.
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 parameter. The value used for this API: DescribeDetailEvent. |
| 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. This API only supports: ap-guangzhou |
| 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. 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 in the format of local UNIX timestamp, such as 1588031999s, which is a point in time in the last 5 days. |
| EndTime | Yes | Integer | Query end time in the format of local UNIX timestamp, such as 1588031999s. |
| UserId | Yes | String | User ID |
| RoomId | Yes | String | Room ID |
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of EventList | List of returned events |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query detailed events of a user such as room entry/exit and video enablement/disablement during a call.
https://trtc.tencentcloudapi.com/?Action=DescribeDetailEvent
&CommId=1400188366_3568_1588055615
&StartTime=1588055615
&EndTime=1588058615
&UserId=user_66319581
&RoomId=1711
&<Common request parameters>{
"Response": {
"Data": [
{
"Content": [
{
"Type": 0,
"Time": 1589975272790,
"EventId": 32793,
"ParamOne": -1,
"ParamTwo": -1
}
],
"PeerId": "hyder11"
},
{
"Content": [
{
"Type": 0,
"Time": 1589975212877,
"EventId": 32793,
"ParamOne": -1,
"ParamTwo": -1
}
],
"PeerId": "user_20453511"
},
{
"Content": [
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32769,
"ParamOne": -1,
"ParamTwo": -1
},
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32791,
"ParamOne": -1,
"ParamTwo": -1
},
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32768,
"ParamOne": -1,
"ParamTwo": -1
},
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32788,
"ParamOne": -1,
"ParamTwo": -1
},
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32793,
"ParamOne": -1,
"ParamTwo": -1
}
],
"PeerId": "user_66319581"
}
],
"RequestId": "093bffd3-9d27-45ca-8410-c61c0e4cdcb8"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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.EsQueryError | An error occurred while querying ES. |
| 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.EndTs | Invalid EndTs. |
| InvalidParameter.StartTs | Invalid StartTs. |
| InvalidParameter.StartTsOversize | The query start time is more than 5 days earlier than now. |
| InvalidParameter.UrlParamsError | Failed to parse the URL parameter. |
| InvalidParameter.UserId | Invalid UserId. |
| MissingParameter | Missing parameter. |
| MissingParameter.CommId | CommId is missing. |
| MissingParameter.EndTs | endTS_s is missing. |
| MissingParameter.StartTs | startTS_s is missing. |
| MissingParameter.UserId | Missing UserId parameter. |
Was this page helpful?