快速开始 Demo 是火山引擎 IM 提供的基本即时通讯 IM 功能的开源示例工程文件。获取该工程文件后，你可以快速构建应用，感受即时通讯 IM 功能；也能通过阅读代码，了解基本即时通讯 IM 的最佳实践。

应用使用说明

使用该项目构建应用后，你可以使用该应用进行 IM 消息的即时发送与接收。你和你的同事必须使用同一个 AppID，才能实现消息的收发，不同的 AppID 之间无法实现互通。

前提条件

• 根据开通服务获取 AppID 和临时 Token

• Android Studio 3.0+

• Android 设备（推荐使用真机进行测试，使用模拟器可能有部分功能无法正常体验）

• IM 快速开始 Demo 工程文件，你可以通过 ZIP 包或 GitHub 仓库获取

操作步骤

步骤 1：配置 Demo 工程文件

1. 使用 Android Studio 打开工程文件。

2. 搜索并打开 Constants.java。

3. 体验国内环境，请在该界面 APP_ID、token和 uid 后分别填入你在控制台上获取的 AppId、临时 Token、用户 ID。
   体验海外环境，请将 APP_ENV 设置为海外环境 ENV_i18n，并在该界面 APP_ID_I18N、token和 uid 后分别填入你在控制台上获取的海外 AppId、临时 Token、用户 ID。然后将工程根目录 gradle.properties 文件中的 isI18n 设置为 true。

步骤 2：编译运行

1. 连接 Android 真机。连接成功后，设备名称将出现在界面上方，如下图所示。

2. 点击菜单栏 Run > Run 'app' 或下图按钮，运行工程文件。

3. 工程运行后，将会在已连接 Android 真机上安装 QuickStart 应用。如果安装过程中，设备弹出风险提示，请选择继续安装。

步骤 3：使用软件

1. 安装成功后，设备屏幕将自动跳转至 QuickStart 应用的登录页面。

2. 阅读用户协议和隐私政策，同意后点击登录。如果你想体验不同用户间收发消息效果，你需要使用不同的用户 ID 和对应的临时 Token 编译运行快速开始 Demo。

3. 登录成功后，应用界面如下图所示。点击右上角可以发起单聊和群聊会话。

4. 创建成功后，会话详情页可以发送和接收消息。

常见问题

1. 打开项目时提示错误 Gradle sync failed: com.android.tools.idea.gradle.project.sync.idea.issues.SdkPlatformNotFoundException: Module: 'app' platform 'android-29' not found
   解决方案：请在 Android Studio 中找到 SDK Manager，在 Appearance & Behavior > System Settings > Android SDK > SDK Platforms 里面勾选缺少的 Android 版本，点击 OK 按钮然后等待下载完成，完成后重启 Android Studio。

2. 打开项目时提示错误 Gradle sync failed: The project is using an incompatible preview version (AGP 7.0.0-beta05) of the Android Gradle plugin.
   解决方案：按照提示升级 AGP 至最新兼容版本。

3. Demo 运行后，出现错误弹窗。
   解决方案：SDK 内部遇到不可恢复的错误，参看错误码。