Skip to content

Commit

Permalink
Merge pull request #19 from haoxiuwen/doc-shengwang
Browse files Browse the repository at this point in the history
Add Enable IM Doc
  • Loading branch information
haoxiuwen authored Jan 3, 2025
2 parents e3a13f9 + 93525b2 commit 351cb19
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
86 changes: 86 additions & 0 deletions docs/document/android/enable_im.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# 开通服务

本文介绍如何开通即时通讯 IM 服务。

## 1. 登录声网控制台

如果你是第一次使用声网服务,点击[注册账号](https://sso.shengwang.cn/cn/v4/signup/with-sms)前往控制台进行注册。注册成功后会自动登录。

如果你已经拥有声网账号,可以直接[登录控制台](https://console.shengwang.cn/)

:::tip
注册和登录过程中如果遇到疑问,可以查看[快速开始](https://doc.shengwang.cn/doc/console/general/quickstart)
:::

## 2. 开通即时通讯 IM 服务

### 创建项目并开通

成功登录控制台后,按照以下步骤创建一个声网项目:

1. 展开控制台左上角下拉框。
2. 点击**创建项目**按钮。
3. 在弹出的对话框内,选择**项目类型****通用项目**,输入**项目名称**,选择**场景标签****鉴权机制**。其中鉴权机制推荐选择**安全模式****调试模式**的安全性较低。
4. 点击**创建新项目**完成项目创建。

创建项目时,默认开通即时通讯 IM 服务。

![img](/images/product/enable_im/console_enable_im_projectcreate.png)

:::tip
如果项目的鉴权机制为**安全模式**,则你需要在初始化 SDK 时填入 Token。详见[获取临时 Token](https://doc.shengwang.cn/doc/rtm2/android/get-started/enable-service#5-获取临时-token)[初始配置](https://doc.shengwang.cn/api-ref/rtm2/android/toc-configuration/configuration)。// TODO:添加各端初始配置链接
:::

### 现有项目中开通

展开控制台左上角下拉框,选择需要开通即时通讯 IM 服务的项目,然后按照以下步骤操作:

1. 点击左侧导航栏的**全部产品**

2. 在下拉列表中找到**即时通讯 IM** 并点击。

3.**即时通讯 IM** 页面,进入**功能配置**标签页.

4. 点击**即时通讯IM服务状态**对应的**启用**按钮。

5. 在弹出窗口中选择数据中心。

:::tip
数据中心的设置将影响你应用中的数据存储区域,此设置一旦启用,后续将不允许修改。
:::

6. 点击**启用**按钮完成开通。

![img](/images/product/enable_im/console_enable_im.png)

成功开通即时通讯 IM 服务后,你的项目就支持了实时聊天功能,你可以根据实际需求配置在**推送证书****推送模板****消息功能****用户状态**页签下配置推送、消息和用户在线状态相关功能。

## 3. 获取 App ID

成功创建项目后,声网会给每个项目自动分配一个 App ID 作为项目唯一标识。你可以直接在**总览**页面的**项目信息**栏,点击 App ID 右侧的复制按钮来获取当前项目的 App ID。

你需要保存好复制的 App ID,后续调用 API 进行初始化等操作时需要传入你获取的 App ID。

![img](/images/product/enable_im/console_obtain_app_id.png)

## 4. 获取临时 Token

对于鉴权机制为安全模式的项目,在后续调用 API 进行聊天等操作时,你还需要传入频道名和 Token 来对用户进行鉴权。

为方便体验和测试,在 App 调试阶段你可以先从控制台获取临时 Token(有效期为 24 小时),无需自行部署 Token 服务器。但在 App 正式上线前,你必须在自己的服务端部署并生成 Token。

在控制台左上角的下拉框,切换到你想要获取临时 Token 的项目,然后按如下步骤获取临时 Token:

1.**总览**页面的**项目信息**栏,点击**临时 Token 生成器**
2.**生成临时 Token** 页面,点击**添加产品**
3. 选择 **RTM** 产品,输入用户 ID,例如 `user1`。然后保存好输入的内容。
4. 点击**确认**
5. 成功生成临时 Token 后,点击 Token 右侧的复制按钮,保存好复制的 Token。

// TODO:这里目前还无法选择即时通讯 IM 产品,因此无法获取临时 token。

## 5. 获取 App 证书

创建好项目后,你可以参考如下步骤获取项目的 App 证书。

在声网控制台**总览**页面的**项目信息**栏,点击**主要证书**/**次要证书**下面的复制图标,即可获取项目的主次 App 证书。

0 comments on commit 351cb19

Please sign in to comment.