README_CN.md

腾讯云 IM 服务端 Java SDK

腾讯云 IM 服务端 Java SDK 封装了腾讯云即时通信 IM 服务端的所有 API 接口，方便服务端开发者进行 REST API 接口的调用以及第三方回调的处理。

English Version

文档导航

• Gitee Pages: https://doocs.gitee.io/qcloud-im-server-sdk-java
• GitHub Pages: https://doocs.github.io/qcloud-im-server-sdk-java

快速上手

1. 添加依赖

注意： 腾讯云 IM 服务端 Java SDK 依赖 JDK 1.8 及以上版本。

如果你的应用程序属于 Maven 工程，请在 pom.xml 文件中引入以下依赖：

<dependency>
  <groupId>io.github.doocs</groupId>
  <artifactId>im-server-sdk-java</artifactId>
  <version>0.4.06</version>
</dependency>

你也可以在 Maven 中央仓库下载 SDK 的 JAR 包，并在项目中引入。

2. 编码实现

// sdk appId
long appId = 1400554812;

// 管理员 userId
String userId = "test";

// 应用程序 key
String key = "60c6c5925f3ae52c7325ac5a8ec78e44c056d1dd84d54e12ffa39911267a2a70";

// 创建 IM 客户端实例
ImClient client = ImClient.getInstance(appId, userId, key);

// 导入账号
AccountImportRequest request = new AccountImportRequest("doocs");
request.setFaceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4");
request.setNick("Doocs Community");
try {
    AccountImportResult result = client.account.accountImport(request);
    // 结果处理
} catch (IOException e) {
    // 异常捕捉处理
}

参与项目

我们非常欢迎各位开发者参与完善 SDK！

本项目，我们使用 dev 作为开发分支，如果你希望参与本项目，请参考以下步骤：

1. 将本项目 fork 到你的个人账号下
2. 将 fork 后的项目 clone 到你本地项目
3. 创建一个新的分支，并添加你的变更
4. 将你的分支与我们上游最新代码保持同步
5. Commit 提交你的分支，注意 commit msg 的格式保持简洁明了
6. 将你的代码 Push 到你在第一步中 fork 下来的项目中
7. 创建一个 Pull Request，请求将你的代码合并到我们 dev 分支

更多详情，请参考 CONTRIBUTING 文档指南。

许可证

Apache-2.0 许可证。