tencent cloud


Last updated: 2022-05-29 11:57:45

    This document describes how to quickly run the IM demo for web.

    Demo UI


    Step 1. Create an app

    1. Log in to the IM console.

      If you already have an app, record its SDKAppID and obtain key information.
      A Tencent Cloud account can create a maximum of 300 IM apps. If you want to create a new app, disable and delete an unwanted app first. Once an app (along with its SDKAppID) is deleted, the provided service and all its data are lost. Please proceed with caution.

    2. Click Create Application, enter your app name, and click Confirm.
    3. Go to the overview page to view the status, service version, SDKAppID, creation time, tag, and expiration time of the application created. Record the SDKAppID.

    Step 2. Obtain key information

    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 disclosure.

    Step 3. Download and configure the demo source code

    1. Download the SDK and demo source code. For more information, see SDK and Demo Source Code.

      # Run in CLI
      git clone https://github.com/tencentyun/TIMSDK.git

      # Go to the web project

      cd TIMSDK/Web/Demo

      # Install dependencies
      npm install
    2. Open the project in the web directory, and find the file GenerateTestUserSig via the path /public/debug/GenerateTestUserSig.js.

    3. Set relevant parameters in the GenerateTestUserSig file:

    • SDKAPPID: Set it to the SDKAppID obtained in Step 1.
    • SECRETKEY: Enter the key 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 disclosed, 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 app-oriented API. When UserSig is needed, your app can send a request to the business server to obtain a dynamic UserSig. For more information, see Generating UserSig on the Server.

    Step 4. Compile and run the demo

    Run the following command in the project terminal via the browser:

    # Run in CLI
    npm run start


    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support