Docs Overview/
Call/
React Native/
Client APIs/
TUICallKit/

TUICallKit

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.
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 your own nickname and profile photo.
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);
   }
);

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.
String filePath = '';
TUICallKit.setCallingBell(filePath);
Parameter
Type
Meaning
filePath
String
Ringtone file address

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);