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 ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集
ドキュメントTencent Real-Time CommunicationCallServer APIsLegacy DocumentationREST APICall RecordsRetrieve Records Based on Conditions

Retrieve Records Based on Conditions

PDF
フォーカスモード
フォントサイズ
最終更新日: 2024-10-29 17:23:23
Administrators can access call records based on specified conditions through this interface.
Note:
The RESTful API is currently in beta. You can query call data created within the past seven days.

API description

Sample request URL

https://xxxxxx/v1/records/get_records_by_filter?sdkappid=88888888&identifier=administrator&usersig=xxx&random=99999999&contenttype=json

Request parameters

The table below only lists the parameters modified when calling this API and their description. For more information, please refer to REST API Overview.
Parameter
Description
xxxxxx
The reserved domain for the country/region where the SDKAppID is located:
callkit-intl.trtc.tencent-cloud.com
v1/records/get_records_by_filter
Request API
sdkappid
SDKAppID assigned by the console when creating an application
identifier
Using the Admin account of Chat
usersig
The Signature generated by the App Administrator account, for detailed operations, please refer to Generating UserSig
random
Enter a random 32-bit unsigned integer, range 0 to 4294967295
contenttype
The request format fixed value is json

Maximum calling frequency

200 queries/sec.

Sample request packets

Basic form Create room
{
    "startTimestamp": 1618705638, 
    "endTimestamp": 1618705738, 
    "callResult": "normal_end", 
    "callType": "single", 
    "numberPerPage": 20, 
    "page": 2 
}

Request packet fields

Field
Type
Attribute
Description
startTimestamp
Integer
Mandatory
Call start timestamp (in seconds)
endTimestamp
Integer
Optional
Call end Timestamp (in seconds), if not specified, the default is 7 days
callResult
String
Optional
Call result, if not specified, defaults to all results
callType
String
Optional
Call type, if not specified, defaults to all types
numberPerPage
Integer
Optional
Number of queries per page, default is: 100
page
Integer
Optional
Query page number, if not specified, defaults to the first page

Response Packet Field Example

{
    "errorCode": 0,
    "errorMessage": "Success",
    "requestId": "8ba14f64a1d92d38705eec775e1f3deb",  
    "data": { 
        "totalNum": 3,
        "page": 2,
        "callRecordList": [
            {
                "callId": "2ae7d549-c441-4a9b-87c0-61810fe19581",
                "sdkAppId": 88888888,
                "mediaType": "video",
                "roomId": "456",
                "startCallTs": 1688709003,
                "acceptTs": 1688709003,
                "endTs": 1689150030,
                "caller": "123",
                "totalUserNumber": 0,
                "callType": "single",
                "callResult": "offline",
                "callees": [
                    "111",
                    "123"
                ]
            },
            {
                "callId": "2ae7d549-c441-4a9b-87c0-61810fe19582",
                "sdkAppId": 88888888,
                "mediaType": "video",
                "roomId": "456",
                "startCallTs": 1688709303,
                "acceptTs": 1688709303,
                "endTs": 1689150030,
                "caller": "123",
                "totalUserNumber": 0,
                "callType": "single",
                "callResult": "offline",
                "callees": [
                    "111",
                    "123"
                ]
            },
            {
                "callId": "2ae7d549-c441-4a9b-87c0-61810fe19583",
                "sdkAppId": 88888888,
                "mediaType": "video",
                "roomId": "456",
                "startCallTs": 1688709903,
                "acceptTs": 1688709903,
                "endTs": 1689150030,
                "caller": "123",
                "totalUserNumber": 0,
                "callType": "single",
                "callResult": "offline",
                "callees": [
                    "111",
                    "123"
                ]
            }
        ]
    }
}

Response Packet Field Description

Field
Type
Description
errorCode
Integer
Error code, 0 indicates success
errorMessage
String
Error message
requestId
String
Unique Request ID
totalNum
Integer
Total Quantity for This Query
page
Integer
When page > 0 it indicates that there is more data, incrementing page by 1 will request subsequent data.
callRecordList
Array
Please refer to: Single Call Record Description

Single Call Record Description

Field
Type
Description
callId
String
Unique ID of the call
sdkAppId
Integer
Your sdkAppId
mediaType
String
Media type
video Video Call
audio Audio Call
roomId
String
Room ID of the call
startCallTs
Integer
Call Initiation Timestamp (in seconds)
acceptTs
Integer
Call Connection Timestamp (in seconds)
endTs
Integer
Call End Timestamp (in seconds)
caller
String
Caller userId
totalUserNumber
Integer
Total Number of Participants in the Call
callType
String
Call type
single One-on-one call
group Group Call
callResult
String
Call Result:
cancel Cancel: The caller cancelled the call before connection.
reject Declined call: The callee rejected.
not_answer Not Answered: The callee did not answer in time.
normal_end Completed: The call was connected and ended normally.
call_busy Busy: The line was busy during the call.
interrupt Interrupts: The call was interrupted due to network or other reasons.
callees
Array
List of callee user IDs who participated in the call
Note:
The callResult field may display all types for one-on-one calls only, while group chats only have normal_end.

Error codes

Unless there is a network error (e.g., a 502 error), the HTTP return code for this interface is always 200. The actual error code and error message are conveyed through errorCode and errorMessage in the response body. For common error codes (70000 to 79999), please see Error Code.
Error code
Description
0
Request succeeded
50001
The current application needs to purchase the TUICallKit Group Call Version Package to use
70011
No records found
Unknown error code
Unknown error, please submit a ticket to contact technical staff


前の記事へ: Retrieve records via callId次の記事へ: End Calls

ヘルプとサポート

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

フィードバック