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 ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集

TUICallKit

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-09-03 15:17:24

TUICallKit API

The TUICallKit API is a UI-inclusive interface for the audio and video call component. By using the TUICallKit API, you can quickly implement a WeChat-like audio and video call scenario through simple interfaces. For more detailed integration steps, please refer to Quick Access to TUICallKit.

TUICallKit APIs

API
Description
login
Login.
logout
Logout.
calls
Initiate a one-to-one or multi-person call.
call
To make a one-on-one call, supports custom room ID, call timeout, offline push content, and more.
groupCall
To make a group call, supports custom room ID, call timeout, offline push content, and more.
Join a group call.
Customize user's ringtone.
Set user's avatar and nickname.
Set whether to turn on the mute mode.
Turn On/Off Ringtone.
Set Screen Orientation.
on
Listen to TUICallKit events
off
Cancel listening to TUICallKit events

API Details

login

Login. This step is crucial. Only after successful login can you use the various features provided by TUICallKit normally.
TUICallKit.login(
{
sdkAppId: 0,
userId: '',
userSig: '',
},
(res) => {
console.log('login success');
},
(errCode, errMsg) => {
console.log('login error');
}
);
Parameter
Type
Meaning
sdkAppId
Number
The unique identifier SDKAppID for the audio and video application created in Tencent RTC Console.
userId
String
Customers define their own User ID based on their business. You can only include letters (a-z, A-Z), digits (0-9), underscores, and hyphens.
userSig
String
SDKSecretKey for the audio and video application created in Tencent RTC Console.

logout

Logout. After logging out, no TUICallKit events will be listened to.
TUICallKit.login(
(res) => {
console.log('login success', res);
},
(errCode, errMsg) => {
console.log('login error', errCode, errMsg);
}
);

calls

Initiate a one-to-one or multi-person call.
TUICallKit.calls(
{
userIdList: userIDList,
mediaType: MediaType.Audio,
callParams: {
offlinePushInfo: {
title: '',
desc: '',
},
},
},
() => {
console.log('calls success');
},
() => {
console.log('calls error');
}
);
Parameter
Type
Meaning
userIdList
Array<String>
The target user IDs.
mediaType
MediaType
The media type of the call, such as video call, voice call.
MediaType.Audio: Voice Call.
MediaType.Video: Video Call.
callParams
call extension parameters include room number, call invitation timeout, offline push custom content, etc.

call

Make a phone call (1v1 call), supports custom room number, call invitation timeout, offline push content, and more.
TUICallKit.call(
{
userId: calleeID,
mediaType: MediaType.Audio,
callParams: {
offlinePushInfo: {
title: '',
desc: '',
},
},
},
() => {
console.log('call success');
},
() => {
console.log('call error');
}
);
Parameter
Type
Meaning
userId
String
target user's userId
mediaType
MediaType
The media type of the call, such as video call, voice call.
MediaType.Audio: Voice Call.
MediaType.Video: Video Call.
callParams
call extension parameters include room number, call invitation timeout, offline push custom content, etc.

groupCall

Initiate group communication.
TUICallKit.groupCall(
{
userIdList: userIDList,
mediaType: MediaType.Audio,
groupId: '',
},
(res) => {
console.log('groupCall success', res);
},
(errCode, errMsg) => {
console.log('groupCall error', errCode, errMsg);
}
);
Parameter
Type
Meaning
groupId
String
The group ID.
userIdList
Array<String>
The target user IDs.
mediaType
MediaType
The media type of the call, such as video call, voice call
MediaType.Audio: Voice Call.
MediaType.Video: Video Call.
callParams
call extension parameters, for example: room number, call invitation timeout, custom content for offline push, etc.

joinInGroupCall

Join an existing audio-video call in a group.
TUICallKit.joinInGroupCall(
{
roomId: '',
groupId: '',
mediaType: '',
}
);
Parameter
Type
Meaning
roomId
RoomId
Audio-Video Room ID for this call
groupId
String
Group ID associated with this group call
mediaType
MediaType
The media type of the call, such as video call, voice call

setCallingBell

Set a custom incoming call ringtone.
The input is restricted to the local MP3 format file address. It is imperative to ensure that the application has access to this file directory.
Use the import method to introduce the ringtone file.
To reset the ringtone, pass in an empty string for filePath.
var filePath: string = '';
TUICallKit.setCallingBell(filePath);
Parameter
Type
Meaning
filePath
String
Ringtone file address

setSelfInfo

This API is used to set the alias and profile photo. The alias cannot exceed 500 bytes, and the profile photo is specified by a URL.
var nickname: string = 'user';
var avatar: string = '';
TUICallKit.setSelfInfo(nickname, userAvatar,
(res) => {
console.log('groupCall success', res);
},
(errCode, errMsg) => {
console.log('groupCall error', errCode, errMsg);
}
);
Parameter
Type
Meaning
nickname
string
The target user names.
avatar
string
The target user avatar.

enableMuteMode

Enable/Disable Ringtone. After enabling, the ringtone will not play when receiving a call request.
Boolean enable = true
TUICallKit.enableMuteMode(enable);
Parameter
Type
Meaning
enable
Boolean
Enable/Disable Ringtone. Default is false.

enableVirtualBackground

Enable/disable blurry background feature. By calling the interface, you can display the blurry background feature button on the UI, and click the button to directly enable the blurry background feature.
Boolean enable = true
TUICallKit.enableVirtualBackground(enable);
Parameter
Type
Meaning
enable
Boolean
enable = true Show blurry background button
enable = false Do not show blurry background button

setScreenOrientation

Set screen display mode.
Number orientation = 0
TUICallKit.setScreenOrientation(orientation);
Parameter
Type
Meaning
orientation
Number
orientation = 0 : Portrait display.
orientation = 1 : Landscape display.
orientation = 2 : Automatically select the best display mode based on the current state of the device.

on

You can listen to TUICallKit events using the example code below. For event details, please refer to TUICallEvent .
TUICallKit.on(TUICallEvent.onCallReceived, (res: any) => {
console.log('onUserReject userId=' + res.userId);
});
Parameter
Type
Meaning
type
String
For the events you are listening to with TUICallKit, please refer to the event list in TUICallEvent .
params
Any
Information carried by the event, please refer to TUICallEvent for details.

off

You can use the following sample code to cancel listening to TUICallKit events.
TUICallKit.off(TUICallEvent.onCallReceived);

ヘルプとサポート

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

フィードバック