Call

Overview

Android
- Run Sample Demo
- Integration
- UI Customization
- Offline Call Push
- On-Cloud Recording
- More Features
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- API Documentation
  - 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
- Release Notes
iOS
- Run Sample Demo
- Integration
- UI Customization
- Offline Call Push
  - VoIP
  - APNs
- On-Cloud Recording
- More Features
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- API Documentation
  - 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
- Release Notes
Web
- Run Sample Demo
- Integration
  - Web&H5 (React)
  - Web&H5 (Vue3)
- UI Customization
- On-Cloud Recording
- More Features
  - Configuring Nicknames and Avatars
  - Configure Resolution and Fill Mode
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- API Documentation
  - API Overview
  - TUICallKit
  - 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
- Release Notes
Flutter
- Run Sample Demo
- Integration
- Offline Call Push
- UI Customization
- On-Cloud Recording
- More Features
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Beauty Effects
  - Custom Ringtone
  - Monitoring Call Status
- API Documentation
  - 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
- Upgrading
- Release Notes
Overview
- Overview

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 procure a package?
Please follow the link Purchase Official Version.
How can I generate 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 "@tencentcloud/call-uikit-vue/debug/GenerateTestUserSig-es.js";
const { userSig } = genTestUserSig({ userID: "Alice", SDKAppID: 0, SecretKey: "YOUT_SECRETKEY" });
Method Three: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 group calls?
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 TIM from "@tencentcloud/chat"; // npm i @tencentcloud/chat
﻿
const userIDList: string[] = ['user1', 'user2', 'xxx'];  // group member
async function createGroupID() {
  const tim = TIM.create({ SDKAppID });
  const memberList: any[] = userIDList.map(userId => ({ userID: userId }));
  const res = await tim.createGroup({
    type: TIM.TYPES.GRP_PUBLIC,  // must be a public group
    name: 'WebSDK',
    memberList
  });
  return res.data.group.groupID;
}
How can I create a userID?
Signing in once with userID and userSig will automatically create the user.
Create and get through the Instant Messaging Console.
﻿
﻿
﻿
﻿