Call

Web
- Overview
  - Product Introduction
  - Activate the Service
  - Pricing
    - Free Minutes
    - Call Monthly Packages
    - Billing Explanation for Subscription Package Duration
- Get Started
  - Run Sample Code
  - Integration (React)
  - Integration (Vue3)
  - Secure authentication with userSig
- Basic Features
  - UI Customization
  - Configuring Nickname and Avatar
  - GroupCall
  - Floating Window
  - Custom Ringtone
  - Configure Resolution and Fill Mode
  - Monitoring Call Status
  - Language Settings
- Advanced Features
  - Virtual Background
  - AI Noise Suppression
  - On-Cloud Recording
- Client APIs
  - UIKit APIs
    - API Overview
    - TUICallKit
  - Engine APIs
    - TUICallEngine
    - TUICallEvent
- Server APIs
  - Call Status Callback
    - Call Status Callback
    - Call Event Callback
    - Callback Configuration
      - API List for Callback Configuration
      - Establishing Callback Configuration
      - Retrieving Callback Configuration
      - Update Callback Configuration
      - Remove Callback Configuration
  - REST API
    - Introduction to REST API
    - Retrieve records via callId
    - Retrieve Records Based on Conditions
- FAQs
  - All Platfroms
  - Web
  - ErrorCode
  - Release Notes
Android
- Overview
  - Product Introduction
  - Activate the Service
  - Pricing
    - Free Minutes
    - Call Monthly Packages
    - Billing Explanation for Subscription Package Duration
- Get Started
  - Run Sample Code
  - Integration
  - Secure authentication with userSig
- Basic Features
  - UI Customization
  - Offline Call Push
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- Advanced Features
  - Virtual Background
  - AI Noise Suppression
  - On-Cloud Recording
- Client APIs
  - UIKit APIs
    - API Overview
    - TUICallKit
    - TUICallObserver
    - Type Definition
  - Engine APIs
    - TUICallEngine
- Server APIs
  - Call Status Callback
    - Call Status Callback
    - Call Event Callback
    - Callback Configuration
      - API List for Callback Configuration
      - Establishing Callback Configuration
      - Retrieving Callback Configuration
      - Update Callback Configuration
      - Remove Callback Configuration
  - REST API
    - Introduction to REST API
    - Retrieve records via callId
    - Retrieve Records Based on Conditions
- FAQs
  - All Platforms
  - Android
  - ErrorCode
  - Release Notes
iOS
- Overview
  - Product Introduction
  - Activate the Service
  - Pricing
    - Free Minutes
    - Call Monthly Packages
    - Billing Explanation for Subscription Package Duration
- Get Started
  - Run Sample Code
  - Integration
  - Secure authentication with userSig
- Basic Features
  - UI Customization
  - Offline Call Push
    - VoIP
    - APNs
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- Advanced Features
  - Virtual Background
  - AI Noise Suppression
  - On-Cloud Recording
- Client APIs
  - UIKit APIs
    - API Overview
    - TUICallKit
    - TUICallObserver
    - Type Definition
  - Engine APIs
    - TUICallEngine
- Server APIs
  - Call Status Callback
    - Call Status Callback
    - Call Event Callback
    - Callback Configuration
      - API List for Callback Configuration
      - Establishing Callback Configuration
      - Retrieving Callback Configuration
      - Update Callback Configuration
      - Remove Callback Configuration
  - REST API
    - Introduction to REST API
    - Retrieve records via callId
    - Retrieve Records Based on Conditions
- FQAs
  - All Platform
  - iOS
  - ErrorCode
  - Release Notes
Flutter
- Overview
  - Product Introduction
  - Activate the Service
  - Pricing
    - Free Minutes
    - Call Monthly Packages
    - Billing Explanation for Subscription Package Duration
- Get Started
  - Run Sample Code
  - Integration
  - Secure authentication with userSig
- Basic Features
  - UI Customization
  - offline Call Push
    - Notification
    - VoIP (Optional)
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- Advanced Features
  - Virtual Background
  - AI Noise Suppression
  - On-Cloud Recording
  - Beauty Effects
- Client APIs
  - API Overview
  - TUICallKit
  - TUICallEngine
  - TUICallObserver
  - Type Definition
- Server APIs
  - Call Status Callback
    - Call Status Callback
    - Call Event Callback
    - Callback Configuration
      - API List for Callback Configuration
      - Establishing Callback Configuration
      - Retrieving Callback Configuration
      - Update Callback Configuration
      - Remove Callback Configuration
  - REST API
    - Introduction to REST API
    - Retrieve records via callId
    - Retrieve Records Based on Conditions
- FQAs
  - All Platform
  - Flutter
  - ErrorCode
  - Upgrading
  - Release Notes

Call

Web

What should I do if I receive the error message "The package you purchased does not support this ability"?
If you encounter the error message above, it's because the Audio and Video Calling Capability Package of your current application has either expired or not been activated. Please refer to Activate Service to claim or activate the audio and video calling capability, and continue to use the TUICallKit Component.
How do I purchase a package?
Please follow the link Purchase Official Version.
How can I generate a UserSig?
UserSig is a type of security signature designed by Tencent Cloud for its cloud services. It serves as a login credential, derived from the encrypted combination of information such as SDKAppID and SecretKey.
Method 1: Accessing from the control panel, refer to  How to Obtain a Temporary UserSig.
Method 2: Deploying a temporary generation script.
Warning:
This approach involves configuring the SecretKey within the front-end code. Regrettably, in this method, the SecretKey can be easily decrypted through reverse engineering. In the event of your key being exposed, attackers can usurp your Tencent Cloud traffic. Therefore,  this method is only suitable for local functional debugging. For a production environment, please refer to Method 3.
For easier initial debugging, GenerateTestUserSig-es.js in the genTestUserSig(params) function can be used temporarily to calculate userSig, for instance:
import { genTestUserSig } from "./debug/GenerateTestUserSig-es.js";
const { userSig } = genTestUserSig({ userID: "Alice", SDKAppID: 0, SecretKey: "YOUT_SECRETKEY" });
Method 3:Use in official environment.
The correct method of issuing UserSig is to integrate the calculation code of UserSig into your server-side, providing project-specific interfaces. When UserSig is needed, your project can launch requests to the business server to obtain dynamic UserSig. For detailed information, please see Generating UserSig on Server-side.
How is the groupID generated in a group call?
The generation of groupID requires integration of the @tencentcloud/chat package. For specifics, refer to the createGroup API; below is an example of the code to generate groupID.
import Chat from "@tencentcloud/chat";   // npm i @tencentcloud/chat
﻿
const userIDList: string[] = ['user1', 'user2'];
async function createGroupID() {
  const chat = Chat.create({ SDKAppID });
  const memberList: any[] = userIDList.map(userId => ({ userID: userId }));
  const res = await chat.createGroup({
    type: Chat.TYPES.GRP_PUBLIC,
    name: 'WebSDK',
    memberList
  });
  return res.data.group.groupID;
}
How do I create a userID?
Unique identifier of the user, defined by you, it is allowed to contain only upper and lower case letters (a-z, A-Z), numbers (0-9), underscores, and hyphens.
Signing in once with userID and userSig will automatically create the user.
Create and get through the Tencent RTC Console.
Error <call>: failed Invalid sender or receiver identifier？
﻿
﻿
﻿
This error occurs because the userID you called does not exist; ensure the userID has signed in at least once. See How do I create a userID for more details.
Error [CallService]API<init>: sdkAppID is required？
﻿
﻿
﻿
This error occurs because you did not fill in the SDKAppID information during TUICallKitServer.init/ GenerateTestUserSig.genTestUserSig
Please obtain and fill in from the Tencent RTC Console.
npm install -g create-react-app error: errno -13？
﻿
﻿
﻿
If this error occurs, it is because the current user does not have permission to globally install scaffolding. Please usesudo npm install -g create-react-app.
npm install -g @vue/cli package error: errno -13？
﻿
﻿
﻿
If this error occurs, it is because the current user does not have permission to globally install scaffolding. Please use sudo npm install -g @vue/cli.

What should I do if I receive the error message "The package you purchased does not support this ability"?
How do I purchase a package?
How can I generate a UserSig?
How is the groupID generated in a group call?
How do I create a userID?
Error <call>: failed Invalid sender or receiver identifier？
Error [CallService]API<init>: sdkAppID is required？
npm install -g create-react-app error: errno -13？
npm install -g @vue/cli package error: errno -13？