lite-chat | 大小 | 功能概述 | 包名 |
精简版 | 200 KB | 初始化，事件监听。 登录登出。 支持文本消息收发。 支持自定义消息收发（可自由定制发送内容）。 支持用户资料和用户状态。 | @tencentcloud/lite-chat/basic |
标准版（默认） | 516 KB | 包含精简版全部功能之外，还支持以下功能： 支持获取历史消息，消息操作，合并转发，已读回执，消息扩展等功能。 支持图片消息，视频消息，语音消息，文件消息收发功能。 支持云端消息（Message）搜索、用户（User）搜索、群组（Group）搜索、群成员搜索等功能。 支持会话列表，会话资料，会话操作等功能。 支持群组管理，群成员管理等功能。 支持社群。 支持直播群。 | @tencentcloud/lite-chat |
完整版 | 609 KB | 包含标准版全部功能之外，还支持以下功能： 支持黑名单，好友管理，好友分组等功能。 支持关注和粉丝功能。 支持会话分组。 支持话题。 | @tencentcloud/lite-chat/professional |
SDKAppID：App 在控制台获取的 Chat 应用的 ID，为应用的唯一标识。SDKSecretKey：应用的密钥。npm install @tencentcloud/lite-chat
// 若同步依赖过程中出现问题，请切换 npm 源后再次重试npm config set registry http://r.cnpmjs.org/
import TencentCloudChat from '@tencentcloud/lite-chat';
SDKAPPID 和 SECRETKEY 生成测试用的 UserSig。你的项目 下创建一个 debug 文件夹（例如 example/chat/debug），复制 debug 文件夹内容到该文件夹中。const { userSig } = genTestUserSig({SDKAPPID: '你的 SDKAppID',SECRETKEY: 'Chat 应用的密钥',userID: '登录的 userID',});
import TencentCloudChat from '@tencentcloud/lite-chat';let options = {SDKAppID: 0 // 接入时需要将0替换为您的即时通信 Chat 应用的 SDKAppID};// 创建 SDK 实例// `TencentCloudChat.create()` 方法对于同一个 `SDKAppID` 只会返回同一份实例// SDK 实例通常用 chat 表示let chat = TencentCloudChat.create(options);// 设置 SDK 日志级别// 0: 普通级别，日志量较多，接入时建议使用// 1: release 级别，SDK 输出关键信息，生产环境时建议使用chat.setLogLevel(0);// chat.setLogLevel(1);
await chat.login({userID: 'your userID',userSig: 'your userSig', // 第一步配置用户鉴权生成的 userSig});
let message = chat.createTextMessage({to: 'userB',conversationType: TencentCloudChat.TYPES.CONV_C2C,payload: {text: 'Hello World!'},});await chat.sendMessage(message);
updateMyProfile。await chat.updateMyProfile({avatar: 'http(s)://url/to/image.jpg',});
followUser。await chat.followUser(['celebrity1', 'celebrity2', 'celebrity3']);// 获取我的粉丝列表await chat.getMyFollowersList();
joinGroup 加入直播组，然后使用 createTextMessage 创建消息，然后使用 sendMessage 发布它。await chat.joinGroup({ groupID: 'group1' });let message = chat.createTextMessage({to: 'group1',conversationType: TencentCloudChat.TYPES.CONV_GROUP,payload: {text: 'AMAZING!!!'},});await chat.sendMessage(message);
文档反馈