機能とサーバーインターフェース
  • クラウドレコーディング
  • CDN へのストリーミング
  • TRTC を介して RTMP との相互接続を実現
  • イベントコールバック
    • イベントコールバック
    • バイパスリレーコールバック
    • クラウドレコーディングのコールバック
    • サイン検証の例
  • メッセージの送受信
  • アクセス管理
    • Overview
    • 認可可能なリソースおよび操作
    • プリセットされたポリシー
    • カスタムポリシー
  • 高度な権限制御の有効化
  • OBS WHIP 経由で TRTC ルームにプッシュする方法
  • サーバー API
    • インターフェースのカテゴリー
    • 過去の記録
    • インターフェースリクエストの発行
      • リクエスト構造
      • 一般的なパラメータ
      • サイン方法 v3
      • サイン
      • 返信
    • ルーム管理インターフェース
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • 通話品質モニタリングインターフェース
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • プッシュ取得の関連インターフェース
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • クラウドレコーディングインターフェース
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • ミクスストリーミング転送の関連インターフェース
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • 使用量統計関連インターフェース
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • データタイプ
    • エラーコード
    • 付録
      • イベント ID マッピングテーブル
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

DescribeUserEvent

1. API Description

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

This API (the old DescribeDetailEvent) is used to query the events of a call in the last 14 days, including user entry and exit, turning the camera on/off, etc.
Note:

  1. 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.
  2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeUserEvent.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionYesStringCommon 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.
CommIdYesStringThe 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.
StartTimeYesIntegerThe 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.
EndTimeYesIntegerThe end time, which is a Unix timestamp (seconds) in local time, such as 1590065877.
Note: If you pass in an end time later than the room end time, the room end time will be used.
UserIdYesStringThe user ID.
RoomIdYesStringThe room ID, such as 223.
SdkAppIdYesIntegerThe application ID, such as 1400xxxxxx.

3. Output Parameters

Parameter NameTypeDescription
DataArray of EventListThe event list. An empty array will be returned if no data is obtained.
RequestIdStringThe 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 events during a call

This example shows you how to query the events during a call, including user entry and exit, turning the camera on/off, etc.

Input Example

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

{
    "StartTime": 1590065777,
    "EndTime": 1590065877,
    "CommId": "1400188366_218695_1590065777",
    "UserId": "user_2045351",
    "SdkAppId": 1400353843,
    "RoomId": "1400"
}

Output Example

{
    "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"
    }
}

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 CodeDescription
InternalErrorInternal error.
InternalError.EsQueryErrorAn error occurred during an ES query.
InternalError.HttpParaseFaliedFailed to parse the HTTP request.
InternalError.InterfaceErrAPI error.
InternalError.MethodErrUnsupported method.
InvalidParameterParameter error.
InvalidParameter.BodyParamsErrorFailed to parse body parameters.
InvalidParameter.EndTsInvalid EndTs.
InvalidParameter.SdkAppidInoperable SdkAppid.
InvalidParameter.StartTsInvalid StartTs.
InvalidParameter.StartTsOversizeThe start time for query exceeded the limit.
InvalidParameter.UrlParamsErrorFailed to parse URL parameters.
InvalidParameter.UserIdInvalid UserId.
MissingParameterMissing parameter.
MissingParameter.AppIdAppId missing.
MissingParameter.CommIdCommId is missing.
MissingParameter.CommIdOrSdkAppIdSdkAppId or CommID missing.
MissingParameter.EndTsendTS_s is missing.
MissingParameter.RoomIdRoomId is missing.
MissingParameter.StartTsstartTS_s is missing.
MissingParameter.UserIdMissing UserId parameter.