English | 简体中文

This document introduces how to quickly run through the IM demo.

In respect for the copyright of the emoji design, the Chat Demo/TUIKit project does not include the cutouts of large emoji elements. Please replace them with your own designed or copyrighted emoji packs before the official launch for commercial use. The default small yellow face emoji pack is copyrighted by Tencent Cloud and can be authorized for a fee. If you wish to obtain authorization, please submit a ticket to contact us.

1. Log in to the IM console.

If you already have an app, record its SDKAppID and configure the app.

2. Click Create Application, enter your app name, and click Confirm.
3. After creation, you can see the status, service version, SDKAppID, creation time, tag, and expiry time of the new app on the overview page of the console. Record the SDKAppID.

1. Click the target app card to go to the basic configuration page of the app.
2. In the Basic Information area, click Display key, and then copy and save the key information.

Please store the key information properly to prevent leakage.

1. Clone the IM demo project from GitHub.
2. Open the project in the terminal directory and find the GenerateTestUserSig file in the following paths:

In this document, an Android project is opened by using Android Studio as an example.

3. Set relevant parameters in the GenerateTestUserSig file:

• SDKAPPID: set it to the SDKAppID obtained in step 1.
• SECRETKEY: enter the actual key information obtained in step 2.

In this document, the method to obtain UserSig is to configure a SECRETKEY in the client code. In this method, the SECRETKEY is vulnerable to decompilation and reverse engineering. Once your SECRETKEY is leaked, attackers can steal your Tencent Cloud traffic. Therefore, this method is only suitable for locally running a demo project and feature debugging. The correct UserSig distribution method is to integrate the calculation code of UserSig into your server and provide an application-oriented API. When UserSig is needed, your app can send a request to the business server for a dynamic UserSig. For more information, please see How do I calculate UserSig on the server?.

Import the demo project with Android Studio, and then compile and run it.

The demo integrates the audio and video call function by default. Since the audio and video SDK that this function depends on does not support the emulator, please use a real device to debug or run the demo.

If you do not need the audio/video call feature, you only delete the audio/video call integration code as shown in the figure below from the build.gradle file under the app module:

api project(':tuicallkit')

After the preceding steps are completed, the audio and video call entries in the demo are hidden. The conversation UIs before and after TUICallKit masking are as follows:

before	After

The contact profile UIs before and after TUICallKit masking are as follows:

before	After

The above only shows how to remove the audio/video call feature from the demo. Developers can customize the demo according to their business requirements.

If you do not need the search feature, you only delete the line of code as shown in the figure below from the build.gradle file under the app module:

api project(':tuisearch')

After the preceding steps are completed, the message search box in the demo is hidden.

The message UIs before and after TUISearch masking are as follows:

before	After

The above only shows how to remove the search feature from the demo. Developers can customize the demo according to their business requirements.