首页
/ Tencent Cloud IM Server SDK Java 技术文档

Tencent Cloud IM Server SDK Java 技术文档

2026-02-04 05:26:11作者:姚月梅Lane

1. 安装指南

环境要求

  • JDK 1.8 或更高版本
  • Maven 3.0+ (推荐)

Maven 安装方式

在项目的 pom.xml 文件中添加以下依赖配置:

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

手动安装方式

  1. 从 Maven 中央仓库下载 JAR 文件
  2. 将下载的 JAR 文件添加到项目构建路径中

2. 项目使用说明

初始化客户端

使用前需要先创建 ImClient 实例:

// SDK AppId
long appId = 1400554812;

// 管理员用户ID
String userId = "test";

// 应用密钥
String key = "60c6c5925f3ae52c7325ac5a8ec78e44c056d1dd84d54e12ffa39911267a2a70";

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

基本功能示例

以下是一个账号导入的示例:

AccountImportRequest request = new AccountImportRequest("doocs");
request.setFaceUrl("https://example.com/avatar.jpg");
request.setNick("示例用户");
try {
    AccountImportResult result = client.account.accountImport(request);
    System.out.println("账号导入结果: " + result);
} catch (IOException e) {
    e.printStackTrace();
}

3. 项目API使用文档

账号管理API

账号导入

AccountImportRequest request = new AccountImportRequest("用户名");
// 可选参数
request.setFaceUrl("头像URL");
request.setNick("昵称");

AccountImportResult result = client.account.accountImport(request);

账号查询

AccountCheckRequest request = new AccountCheckRequest();
request.setCheckItem(Arrays.asList("user1", "user2"));

AccountCheckResult result = client.account.accountCheck(request);

消息管理API

单发消息

SendMsgRequest request = new SendMsgRequest();
request.setToAccount("接收方用户ID");
request.setMsgBody(Arrays.asList(new MsgBodyItem("TIMTextElem", 
    new HashMap<String, String>() {{
        put("Text", "测试消息");
    }}
)));

SendMsgResult result = client.message.sendMsg(request);

4. 项目安装方式总结

推荐安装方式

  1. Maven依赖 (推荐)

    • 适合大多数Java项目
    • 自动处理依赖关系
    • 版本更新方便
  2. 手动安装

    • 适合无法使用Maven的项目
    • 需要手动管理依赖

版本选择建议

  • 生产环境建议使用最新稳定版
  • 开发环境可以使用最新版本进行测试

注意事项

  • 请妥善保管您的AppId和应用密钥
  • 建议在正式环境使用前先在测试环境验证功能
  • 调用API时注意异常处理

以上文档提供了Tencent Cloud IM Server SDK Java版的基本使用指南,开发者可根据实际需求参考使用。如需更详细的功能说明,请查阅SDK源码或相关接口文档。

登录后查看全文
热门项目推荐
相关项目推荐