tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动（含 UI）
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务（Push）
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们
文档即时通信 IM客户端 APIJavaScript

JavaScript

PDF
聚焦模式
字号
最后更新时间： 2025-03-24 10:40:08

TencentCloudChat

TencentCloudChat 是 Chat Web SDK 的命名空间，提供了创建 SDK 实例的静态方法 create() ，以及事件常量 EVENT，类型常量 TYPES， 信令常量 TSignaling。

初始化

API
描述
create
创建 SDK 实例。

SDK 实例

基本概念
说明
Message（消息）
Chat SDK 中 Message 表示要发送给对方的内容，消息包括若干属性，例如自己是否为发送者，发送人账号以及消息产生时间等。
Conversation（会话）
Chat SDK 中 Conversation 分为两种：
C2C（Client to Client）会话，表示单聊情况，自己与对方建立的对话。
GROUP（群）会话，表示群聊情况下群内成员组成的会话。
Profile（资料）
Chat SDK 中 Profile 描述个人的常用基本信息，例如昵称、性别、个性签名以及头像地址等。
Friend（好友）
Chat SDK 中 Friend 描述好友的常用基本信息，例如备注、分组等。
FriendApplication（好友申请）
Chat SDK 中 FriendApplication 描述好友申请的常用基本信息，例如加好友来源、备注等。
FriendGroup（好友分组）
Chat SDK 中 FriendGroup 描述好友分组的常用基本信息，例如分组名、分组成员等。
Group（群组）
Chat SDK 中 Group 表示一个支持多人聊天的通信系统，支持好友工作群、陌生人社交群、临时会议群以及直播群。
GroupMember（群成员）
Chat SDK 中 GroupMember 描述群内成员的常用基本信息，例如 ID、昵称、群内身份以及入群时间等。
Signaling（信令）
Chat SDK 中 Signaling 描述信令的常用基本信息。例如 ID、邀请者 ID、被邀请人 ID 列表，操作类型、超时时间等。
群提示消息
当有用户被邀请加入群组或被移出群组等事件发生时，群内会产生提示消息，接入侧可以根据实际需求展示给群组用户或忽略。
群提示消息有多种类型，详细描述请参见 Message.GroupTipPayload。
群系统通知消息
当有用户申请加群等事件发生时，管理员会收到申请加群等系统消息。管理员同意或拒绝加群申请，Chat SDK 会通过群系统通知消息将申请加群等相应消息发送给接入侧，由接入侧展示给用户。
群系统通知消息有多种类型，详细描述请参见 Message.GroupSystemNoticePayload。
消息上屏
用户单击发送后，事先输入的文字或选择的图片等信息显示在用户电脑屏幕或手机屏幕上的过程。

事件相关

API
描述
on
监听事件。
off
取消监听事件。

注册插件

API
描述
注册插件。

设置日志级别

API
描述
设置日志级别。

SDK 是否 ready

API
描述
isReady
SDK 是否 ready。SDK ready 后，开发者可调用 SDK 发送消息等 API，使用 SDK 的各项功能。

销毁 SDK 实例

API
描述
destroy
销毁 SDK 实例。

登录相关

API
描述
login
登录。
logout
登出。

消息

API
描述
创建文本消息。
创建可以附带 @ 提醒功能的文本消息。
创建图片消息。
创建音频消息。
创建视频消息。
创建自定义消息。
创建表情消息。
创建文件消息。
创建地理位置消息。
创建合并消息。
下载合并消息。
创建转发消息。
发送消息。
搜索云端消息。
撤回消息。
重发消息。
删除消息。
设置消息扩展。
获取消息扩展。
删除消息扩展。

会话

API
描述
变更消息。
获取消息列表。
根据指定的消息 sequence 或 消息时间拉取会话的消息列表。
发送消息已读回执。
拉取已读回执列表。
获取群消息已读（或未读）群成员列表。
根据 messageID 查询会话的本地消息。
将某会话下的未读消息状态设置为已读，置为已读的消息不会计入到未读统计。
获取会话列表。
获取会话资料。
删除会话。
清空单聊或群聊本地及云端的消息（不删除会话）。
置顶或取消置顶会话。
将所有会话的未读消息设置为已读。
设置会话消息提醒类型，您可以使用此接口实现“消息免打扰”，“拒收消息”的功能。
获取会话未读总数。

会话分组

API
描述
设置会话自定义数据。
标记会话。
获取会话分组列表。
创建会话分组。
删除会话分组。
重命名会话分组。
添加会话到一个会话分组。
从一个会话分组中删除会话。

搜索

API
描述
搜索云端消息。
搜索云端用户。
搜索云端群列表。
搜索云端群成员列表。

资料

API
描述
获取个人资料。
获取其他用户资料。
更新个人资料。
获取我的黑名单列表。
添加用户到黑名单列表。
将用户从黑名单中移除。

用户状态

API
描述
设置自己的自定义状态。
查询用户状态。
订阅用户状态。
取消订阅用户状态。

关系链

API
描述
获取 SDK 缓存的好友列表。
addFriend
添加好友。
删除好友。
校验好友关系。
获取指定好友的好友数据和资料数据。
更新好友的关系链数据。
获取 SDK 缓存的好友申请列表。
同意好友申请。
拒绝好友申请。
删除好友申请。
上报好友申请已读。
获取 SDK 缓存的好友分组列表。
创建好友分组。
删除好友分组。
添加好友到分组列表。
从好友分组移除好友。
修改好友分组的名称。

群组

API
描述
获取群组列表。
获取群详细资料。
创建群组。
解散群组。
修改群组资料。
joinGroup
申请加群。
quitGroup
退出群组。
搜索群组。
获取直播群在线人数。
转让群组。
获取加群申请列表。
处理申请加群。
初始化群属性。
设置群属性。
删除群属性。
获取群属性。
设置群计数器。
递增群计数器。
递减群计数器。
获取群计数器。

群成员

API
描述
获取群成员列表。
获取群成员资料。
添加群成员。
删除群成员。
设置群成员的禁言时间。
修改群成员角色。
设置群成员名片。
设置群成员自定义字段。
标记群成员。

话题

API
描述
获取当前用户已经加入的支持话题的社群列表。
创建话题。
删除话题。
更新话题资料。
获取话题列表。

信令

API
描述
监听信令事件。
移除监听信令事件。
invite
邀请某个人。
邀请群内的某些人。
cancel
邀请发起者取消邀请。
accept
被邀请人接受邀请。
reject
被邀请人拒绝邀请。
获取信令信息。
修改邀请信令。

上一篇: Android&iOS&Windows&Mac下一篇: Android

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈