tencent cloud

Tencent Real-Time Communication

소식 및 공지 사항
제품 업데이트
Tencent Cloud 오디오/비디오 단말 SDK 재생 업그레이드 및 권한 부여 인증 추가
TRTC 월간 구독 패키지 출시 관련 안내
제품 소개
제품 개요
기본 개념
제품 기능
제품 장점
응용 시나리오
성능 데이터
구매 가이드
Billing Overview
무료 시간 안내
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
과금 FAQ
Refund Instructions
신규 사용자 가이드
Demo 체험
Call
개요(TUICallKit)
Activate the Service
Run Demo
빠른 통합(TUICallKit)
오프라인 푸시
Conversational Chat
온클라우드 녹화(TUICallKit)
AI Noise Reduction
UI 사용자 정의
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
릴리스 노트
FAQs
라이브 스트리밍
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 클라이언트 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
FAQs
과금 개요
기능 관련
UserSig 관련
방화벽 제한 처리
설치 패키지 용량 축소 관련 질문
Andriod 및 iOS 관련
Web 관련
Flutter 관련
Electron 관련
TRTCCalling Web 관련
멀티미디어 품질 관련
기타 질문
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);

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백