概述
本文主要介绍如何快速将腾讯云即时通信 IM SDK 集成到您的 Web、小程序项目中。

npm 集成
在您的项目中使用 npm 安装相应依赖。
npm install @tencentcloud/lite-chat
引入 SDK
import TencentCloudChat from '@tencentcloud/lite-chat';const SDKAppID = 0; // 接入时需要将0替换为您的即时通信 IM 应用的 SDKAppID// 创建 SDK 实例,`TIM.create()`方法对于同一个 `SDKAppID` 只会返回同一份实例let chat = TencentCloudChat.create({SDKAppID}); // SDK 实例通常用 chat 表示
登录
const userID = ''; // 您的 userIDconst userSig = ''; // 用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文// 登录 Chatlet promise = chat.login({ userID, userSig });promise.then(function(imResponse) {console.log(imResponse.data); // 登录成功if (imResponse.data.repeatLogin === true) {// 标识账号已登录,本次登录操作为重复登录。console.log(imResponse.data.errorInfo);}}).catch(function(imError) {console.warn('login error:', imError); // 登录失败的相关信息});
版本区分
注意:
1. @tencentcloud/lite-chat 已包含精简版、标准版、完整版的 SDK,无需下载新的依赖。
2. SDK 默认集成标准版。
精简版集成消息收发和用户管理功能,满足 IM 的核心能力,体积不超过 200 KB,仅占全量 SDK 大小的 30%,下面列举 SDK 各个版本的功能及体积。
lite - Chat | 大小 | 功能概述 |
192 KB | 初始化,事件监听。 登录登出。 支持文本消息收发。 支持自定义消息收发(可自由定制发送内容)。 支持用户资料和用户状态。 | |
499 KB | 包含精简版全部功能外 支持获取历史消息,消息操作,合并转发,已读回执,消息扩展等功能。 支持图片消息,视频消息,语音消息,文件消息收发功能。 支持云端消息(Message)搜索、用户(User)搜索、群组(Group)搜索、群成员搜索等功能。 支持会话列表,会话资料,会话操作等功能。 支持群组管理,群成员管理等功能。 支持信令。 支持社群。 支持直播群。 | |
593 KB | 包含标准版全部功能外 支持黑名单,好友管理,好友分组等功能。 支持关注和粉丝功能。 支持会话分组。 支持话题。 |
精简版
import TencentCloudChat from '@tencentcloud/lite-chat/basic'
API | 描述 |
创建 SDK 实例。 | |
销毁 SDK 实例。 | |
监听事件。 | |
取消监听事件。 | |
登录。 | |
登出。 | |
获取当前登录用户。 | |
获取服务器时间。 | |
创建文本消息。 | |
创建单聊自定义消息。 | |
发送消息。 | |
修改消息(不支持修改群消息)。 | |
获取自己的资料。 | |
获取用户资料。 | |
更新自己的资料。 | |
设置自己的状态。 | |
获取用户状态。 | |
订阅用户状态。 | |
取消订阅用户状态。 |
标准版
注意:
import TencentCloudChat from '@tencentcloud/lite-chat'
高级消息收发
API | 描述 |
创建图片消息。 | |
创建语音消息。 | |
创建视频消息。 | |
创建文件消息。 | |
创建表情消息。 | |
创建@消息。 | |
创建转发消息。 | |
创建合并消息。 | |
下载合并消息。 | |
撤回消息。 | |
重发消息。 | |
删除消息。 | |
获取消息列表。 | |
根据消息序列号获取消息列表。 | |
添加消息表情回应。 | |
删除消息表情回应。 | |
获取消息表情回应。 | |
获取消息表情回应用户列表。 | |
发送消息已读回执。 | |
获取消息已读回执列表。 | |
获取群消息已读成员列表。 | |
查找消息。 | |
翻译文本。 | |
语音转文字。 | |
设置消息扩展。 | |
获取消息扩展。 | |
删除消息扩展。 |
会话相关
API | 描述 |
获取会话列表。 | |
获取会话资料。 | |
获取未读消息总数。 | |
设置消息已读。 | |
置顶会话。 | |
删除会话。 | |
设置消息提醒方式。 | |
设置会话草稿。 | |
设置全局消息免打扰选项。 | |
获取全局消息免打扰选项。 | |
将所有会话的未读消息设置为已读。 | |
清空单聊或群聊本地及云端的消息(不删除会话)。 |
群组相关
API | 描述 |
获取群组列表。 | |
获取群详细资料。 | |
创建群组。 | |
解散群组。 | |
更新群资料。 | |
加入群组。 | |
退出群组。 | |
搜索群组。 | |
获取群在线人数。 | |
转让群主。 | |
获取群申请列表。 | |
处理群申请。 | |
初始化群属性。 | |
设置群属性。 | |
删除群属性。 | |
获取群属性。 | |
获取群成员列表。 | |
获取群成员资料。 | |
添加群成员。 | |
删除群成员。 | |
设置群成员禁言时间。 | |
设置群成员角色。 | |
设置群成员名片。 | |
设置群成员自定义字段。 | |
标记群成员列表。 | |
设置群计数器。 | |
递增群计数器。 | |
递减群计数器。 | |
获取群计数器。 | |
获取直播群在线成员人数。 | |
获取直播群成员列表。 | |
删除直播群成员。 | |
标记直播群成员。 |
云端搜索
API | 描述 |
搜索云端消息。 | |
搜索云端用户。 | |
搜索群组成员。 |
信令相关
API | 描述 |
添加信令监听器。 | |
移除信令监听器。 | |
邀请。 | |
取消邀请。 | |
接受邀请。 | |
拒绝邀请。 | |
获取信令信息。 | |
修改邀请。 |
完整版
注意:
import TencentCloudChat from '@tencentcloud/lite-chat/professional'
关系链
API | 描述 |
获取黑名单列表。 | |
添加到黑名单。 | |
从黑名单移除。 | |
获取好友列表。 | |
添加好友。 | |
删除好友。 | |
检查好友关系。 | |
获取好友资料。 | |
更新好友资料。 | |
获取好友申请列表。 | |
接受好友申请。 | |
拒绝好友申请。 | |
删除好友申请。 | |
设置好友申请已读。 | |
获取好友分组列表。 | |
创建好友分组。 | |
删除好友分组。 | |
添加到好友分组。 | |
从好友分组移除。 | |
重命名好友分组。 |
关注/粉丝
API | 描述 |
关注用户。 | |
取消关注用户。 | |
获取我的粉丝列表。 | |
获取我的关注列表。 | |
获取互关列表。 | |
获取指定用户的关注/粉丝/互关数量信息。 | |
检查指定用户的关注关系。 |
会话分组
API | 描述 |
设置自定义会话数据。 | |
标记会话。 | |
获取会话分组列表。 | |
创建会话分组。 | |
删除会话分组。 | |
重命名会话分组。 | |
添加会话到一个会话分组。 | |
从一个会话分组中删除会话。 |
话题
API | 描述 |
获取支持话题的社群列表。 | |
创建话题。 | |
删除话题。 | |
更新话题资料。 | |
获取话题列表。 |