tencent cloud

Tencent Real-Time Communication

お知らせ・リリースノート
製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
製品の説明
製品概要
基礎概念
製品の機能
製品の強み
ユースケース
性能データ
購入ガイド
Billing Overview
無料時間の説明
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
課金に関するよくあるご質問
Refund Instructions
初心者ガイド
Demo体験
Call
コンポーネントの説明(TUICallKit)
Activate the Service
Run Demo
クイック導入
オフライン通知
Conversational Chat
クラウドレコーディング(TUICallKit)
AI Noise Reduction
インターフェースのカスタマイズ
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
公開ログ
よくある質問
ライブ配信
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Demo のクイックスタート
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDKのダウンロード
APIコードサンプル
Usage Guidelines
クライアント側 API
高度な機能
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
コンソールガイド
アプリケーション管理
使用統計
監視ダッシュボード
開発支援
Solution
Real-Time Chorus
よくあるご質問
課金関連問題
機能関連
UserSig関連
ファイアウォールの制限の対応関連
インストールパッケージの圧縮に関するご質問
AndriodおよびiOS関連
Web端末関連
Flutter関連
Electron関連
TRTCCalling Web関連
オーディオビデオ品質関連
その他のご質問
旧バージョンのドキュメント
TUIRoom(Web)の統合
TUIRoom (Android)の統合
TUIRoom (iOS)の統合
TUIRoom (Flutter)の統合
TUIRoom (Electron)の統合
TUIRoom APIのクエリー
クラウドレコーディングと再生の実現(旧)
Protocols and Policies
セキュリティコンプライアンス認証
セキュリティホワイトペーパー
情報セキュリティの説明
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集

DescribeUserEvent

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-11-13 20:48:05

1. API Description

Domain name for API request: trtc.intl.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://trtc.io/document/54481?product=pricing.

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 Params. The value used for this API: DescribeUserEvent.
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: If you pass in an end time later than the room end time, the room end time will be used.
UserId Yes String The user ID.
RoomId Yes String The room ID, such as 223.
SdkAppId Yes Integer The application ID, such as 1400xxxxxx.

3. Output Parameters

Parameter Name Type Description
Data Array of EventList The event list. An empty array will be returned if no data is 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.

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.intl.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 Code Description
InternalError Internal error.
InternalError.EsQueryError An error occurred during an ES query.
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.EndTs Invalid EndTs.
InvalidParameter.SdkAppid Inoperable SdkAppid.
InvalidParameter.StartTs Invalid StartTs.
InvalidParameter.StartTsOversize The start time for query exceeded the limit.
InvalidParameter.UrlParamsError Failed to parse URL parameters.
InvalidParameter.UserId Invalid UserId.
MissingParameter Missing parameter.
MissingParameter.AppId AppId missing.
MissingParameter.CommId CommId is missing.
MissingParameter.CommIdOrSdkAppId SdkAppId or CommID missing.
MissingParameter.EndTs endTS_s is missing.
MissingParameter.RoomId RoomId is missing.
MissingParameter.StartTs startTS_s is missing.
MissingParameter.UserId Missing UserId parameter.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック