即时通信 IM Web & 小程序 & uni-app

以下视频将帮助您快速了解 Web 和小程序端 SDK API：
﻿
TencentCloudChat
TencentCloudChat 是 IM Web SDK 的命名空间，提供了创建 SDK 实例的静态方法 create() ，以及事件常量 EVENT 和类型常量 TYPES。
初始化
API
描述
﻿create﻿
创建 SDK 实例。
SDK 实例
基本概念
说明
Message（消息）
IM SDK 中 Message 表示要发送给对方的内容，消息包括若干属性，例如自己是否为发送者，发送人账号以及消息产生时间等。
Conversation（会话）
IM SDK 中 Conversation 分为两种：
C2C（Client to Client）会话，表示单聊情况，自己与对方建立的对话。
GROUP（群）会话，表示群聊情况下群内成员组成的会话。
Profile（资料）
IM SDK 中 Profile 描述个人的常用基本信息，例如昵称、性别、个性签名以及头像地址等。
Friend（好友）
IM SDK 中 Friend 描述好友的常用基本信息，例如备注、分组等。
FriendApplication（好友申请）
IM SDK 中 FriendApplication 描述好友申请的常用基本信息，例如加好友来源、备注等。
FriendGroup（好友分组）
IM SDK 中 FriendGroup 描述好友分组的常用基本信息，例如分组名、分组成员等。
Group（群组）
IM SDK 中 Group 表示一个支持多人聊天的通信系统，支持好友工作群、陌生人社交群、临时会议群以及直播群。
GroupMember（群成员）
IM SDK 中 GroupMember 描述群内成员的常用基本信息，例如 ID、昵称、群内身份以及入群时间等。
群提示消息
当有用户被邀请加入群组或被移出群组等事件发生时，群内会产生提示消息，接入侧可以根据实际需求展示给群组用户或忽略。
群提示消息有多种类型，详细描述请参见  Message.GroupTipPayload。
群系统通知消息
当有用户申请加群等事件发生时，管理员会收到申请加群等系统消息。管理员同意或拒绝加群申请，IM SDK 会通过群系统通知消息将申请加群等相应消息发送给接入侧，由接入侧展示给用户。
群系统通知消息有多种类型，详细描述请参见 Message.GroupSystemNoticePayload。
消息上屏
用户单击发送后，事先输入的文字或选择的图片等信息显示在用户电脑屏幕或手机屏幕上的过程。
事件相关
API
描述
﻿on﻿
监听事件。
﻿off﻿
取消监听事件。
注册插件
API
描述
﻿registerPlugin﻿
注册插件。
设置日志级别
API
描述
﻿setLogLevel﻿
设置日志级别。
SDK 是否 ready
API
描述
﻿isReady﻿
SDK 是否 ready。SDK ready 后，开发者可调用 SDK 发送消息等 API，使用 SDK 的各项功能。
销毁 SDK 实例
API
描述
﻿destroy﻿
销毁 SDK 实例。
登录相关
API
描述
﻿login﻿
登录。
﻿logout﻿
登出。
﻿getLoginUser﻿
已登录返回登录用户的 userID，未登录返回''。
﻿getServerTime﻿
获取服务器时间。
消息
API
描述
﻿createTextMessage﻿
创建文本消息。
﻿createTextAtMessage﻿
创建可以附带 @ 提醒功能的文本消息。
﻿createImageMessage﻿
创建图片消息。
﻿createAudioMessage﻿
创建音频消息。
﻿createVideoMessage﻿
创建视频消息。
﻿createCustomMessage﻿
创建自定义消息。
﻿createFaceMessage﻿
创建表情消息。
﻿createFileMessage﻿
创建文件消息。
﻿createLocationMessage﻿
创建地理位置消息。
﻿createMergerMessage﻿
创建合并消息。
﻿downloadMergerMessage﻿
下载合并消息。
﻿createForwardMessage﻿
创建转发消息。
﻿sendMessage﻿
发送消息。
﻿revokeMessage﻿
撤回消息。
﻿resendMessage﻿
重发消息。
﻿deleteMessage﻿
删除消息。
﻿translateText﻿
翻译文本消息。
﻿convertVoiceToText﻿
语音转文字。
﻿setMessageExtensions﻿
设置消息扩展。
﻿getMessageExtensions﻿
获取消息扩展。
﻿deleteMessageExtensions﻿
删除消息扩展。
﻿addMessageReaction﻿
添加消息回应。
﻿removeMessageReaction﻿
删除消息回应。
﻿getMessageReactions﻿
批量拉取多条消息回应信息。
﻿getAllUserListOfMessageReaction﻿
分页拉取指定消息回应的用户列表。
会话
API
描述
﻿modifyMessage﻿
变更消息。
﻿getMessageList﻿
获取消息列表。
﻿getMessageListHopping﻿
根据指定的消息 sequence 或 消息时间拉取会话的消息列表。
﻿sendMessageReadReceipt﻿
发送消息已读回执。
﻿getMessageReadReceiptList﻿
拉取已读回执列表。
﻿getGroupMessageReadMemberList﻿
获取群消息已读（或未读）群成员列表。
﻿findMessage﻿
根据 messageID 查询会话的本地消息。
setMessageRead
将某会话下的未读消息状态设置为已读，置为已读的消息不会计入到未读统计。
﻿getConversationList﻿
获取会话列表。
﻿getConversationProfile﻿
获取会话资料。
﻿deleteConversation﻿
删除会话。
﻿clearHistoryMessage﻿
清空单聊或群聊本地及云端的消息（不删除会话）。
﻿pinConversation﻿
置顶或取消置顶会话。
﻿setAllMessageRead﻿
将所有会话的未读消息设置为已读。
﻿setMessageRemindType﻿
设置会话消息提醒类型，您可以使用此接口实现“消息免打扰”，“拒收消息”的功能。
﻿getTotalUnreadMessageCount﻿
获取会话未读总数。
会话分组
API
描述
﻿setConversationCustomData﻿
设置会话自定义数据。
﻿markConversation﻿
标记会话。
﻿getConversationGroupList﻿
获取会话分组列表。
﻿createConversationGroup﻿
创建会话分组。
﻿deleteConversationGroup﻿
删除会话分组。
﻿renameConversationGroup﻿
重命名会话分组。
﻿addConversationsToGroup﻿
添加会话到一个会话分组。
﻿deleteConversationsFromGroup﻿
从一个会话分组中删除会话。
搜索
API
描述
﻿searchCloudMessages﻿
搜索云端消息。
﻿searchCloudUsers﻿
搜索云端用户。
﻿searchCloudGroups﻿
搜索云端群列表。
﻿searchCloudGroupMembers﻿
搜索云端群成员列表。
资料
API
描述
﻿getMyProfile﻿
获取个人资料。
﻿getUserProfile﻿
获取其他用户资料。
﻿updateMyProfile﻿
更新个人资料。
﻿getBlacklist﻿
获取我的黑名单列表。
﻿addToBlacklist﻿
添加用户到黑名单列表。
﻿removeFromBlacklist﻿
将用户从黑名单中移除。
用户状态
API
描述
﻿setSelfStatus﻿
设置自己的自定义状态。
﻿getUserStatus﻿
查询用户状态。
﻿subscribeUserStatus﻿
订阅用户状态。
﻿unsubscribeUserStatus﻿
取消订阅用户状态。
关系链
API
描述
﻿getFriendList﻿
获取 SDK 缓存的好友列表。
﻿addFriend﻿
添加好友。
﻿deleteFriend﻿
删除好友。
﻿checkFriend﻿
校验好友关系。
﻿getFriendProfile﻿
获取指定好友的好友数据和资料数据。
﻿updateFriend﻿
更新好友的关系链数据。
﻿getFriendApplicationList﻿
获取 SDK 缓存的好友申请列表。
﻿acceptFriendApplication﻿
同意好友申请。
﻿refuseFriendApplication﻿
拒绝好友申请。
﻿deleteFriendApplication﻿
删除好友申请。
﻿setFriendApplicationRead﻿
上报好友申请已读。
﻿getFriendGroupList﻿
获取 SDK 缓存的好友分组列表。
﻿createFriendGroup﻿
创建好友分组。
﻿deleteFriendGroup﻿
删除好友分组。
﻿addToFriendGroup﻿
添加好友到分组列表。
﻿removeFromFriendGroup﻿
从好友分组移除好友。
﻿renameFriendGroup﻿
修改好友分组的名称。
关注和粉丝
API
描述
﻿followUser﻿
关注用户。
﻿unfollowUser﻿
取消关注。
﻿getMyFollowersList﻿
获取我的粉丝列表。
﻿getMyFollowingList﻿
获取我的关注列表。
﻿getMutualFollowersList﻿
获取互关列表。
﻿getUserFollowInfo﻿
获取指定用户的 关注/粉丝/互关 数量信息。
﻿checkFollowType﻿
检查指定用户的关注关系。
群组
API
描述
﻿getGroupList﻿
获取群组列表。
﻿getGroupProfile﻿
获取群详细资料。
﻿createGroup﻿
创建群组。
﻿dismissGroup﻿
解散群组。
﻿updateGroupProfile﻿
修改群组资料。
﻿joinGroup﻿
申请加群。
﻿quitGroup﻿
退出群组。
﻿searchGroupByID﻿
搜索群组。
﻿getGroupOnlineMemberCount﻿
获取群在线人数。
﻿changeGroupOwner﻿
转让群组。
﻿getGroupApplicationList﻿
获取加群申请列表。
﻿handleGroupApplication﻿
处理申请加群。
﻿initGroupAttributes﻿
初始化群属性。
﻿setGroupAttributes﻿
设置群属性。
﻿deleteGroupAttributes﻿
删除群属性。
﻿getGroupAttributes﻿
获取群属性。
﻿setGroupCounters﻿
设置群计数器。
﻿increaseGroupCounter﻿
递增群计数器。
﻿decreaseGroupCounter﻿
递减群计数器。
﻿getGroupCounters﻿
获取群计数器。
群成员
API
描述
﻿getGroupMemberList﻿
获取群成员列表。
﻿getGroupMemberProfile﻿
获取群成员资料。
﻿addGroupMember﻿
添加群成员。
﻿deleteGroupMember﻿
删除群成员。
﻿setGroupMemberMuteTime﻿
设置群成员的禁言时间。
﻿setGroupMemberRole﻿
修改群成员角色。
﻿setGroupMemberNameCard﻿
设置群成员名片。
﻿setGroupMemberCustomField﻿
设置群成员自定义字段。
﻿markGroupMemberList﻿
标记群成员。
话题
API
描述
﻿getJoinedCommunityList﻿
获取当前用户已经加入的支持话题的社群列表。
﻿createTopicInCommunity﻿
创建话题。
﻿deleteTopicFromCommunity﻿
删除话题。
﻿updateTopicProfile﻿
更新话题资料。
﻿getTopicList﻿
获取话题列表。
﻿

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

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

API	描述
login	登录。
logout	登出。
getLoginUser	已登录返回登录用户的 userID，未登录返回`''`。
getServerTime	获取服务器时间。

API	描述
createTextMessage	创建文本消息。
createTextAtMessage	创建可以附带 @ 提醒功能的文本消息。
createImageMessage	创建图片消息。
createAudioMessage	创建音频消息。
createVideoMessage	创建视频消息。
createCustomMessage	创建自定义消息。
createFaceMessage	创建表情消息。
createFileMessage	创建文件消息。
createLocationMessage	创建地理位置消息。
createMergerMessage	创建合并消息。
downloadMergerMessage	下载合并消息。
createForwardMessage	创建转发消息。
sendMessage	发送消息。
revokeMessage	撤回消息。
resendMessage	重发消息。
deleteMessage	删除消息。
translateText	翻译文本消息。
convertVoiceToText	语音转文字。
setMessageExtensions	设置消息扩展。
getMessageExtensions	获取消息扩展。
deleteMessageExtensions	删除消息扩展。
addMessageReaction	添加消息回应。
removeMessageReaction	删除消息回应。
getMessageReactions	批量拉取多条消息回应信息。
getAllUserListOfMessageReaction	分页拉取指定消息回应的用户列表。

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

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

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

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

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

API	描述
getFriendList	获取 SDK 缓存的好友列表。
addFriend	添加好友。
deleteFriend	删除好友。
checkFriend	校验好友关系。
getFriendProfile	获取指定好友的好友数据和资料数据。
updateFriend	更新好友的关系链数据。
getFriendApplicationList	获取 SDK 缓存的好友申请列表。
acceptFriendApplication	同意好友申请。
refuseFriendApplication	拒绝好友申请。
deleteFriendApplication	删除好友申请。
setFriendApplicationRead	上报好友申请已读。
getFriendGroupList	获取 SDK 缓存的好友分组列表。
createFriendGroup	创建好友分组。
deleteFriendGroup	删除好友分组。
addToFriendGroup	添加好友到分组列表。
removeFromFriendGroup	从好友分组移除好友。
renameFriendGroup	修改好友分组的名称。

API	描述
followUser	关注用户。
unfollowUser	取消关注。
getMyFollowersList	获取我的粉丝列表。
getMyFollowingList	获取我的关注列表。
getMutualFollowersList	获取互关列表。
getUserFollowInfo	获取指定用户的关注/粉丝/互关数量信息。
checkFollowType	检查指定用户的关注关系。

API	描述
getGroupList	获取群组列表。
getGroupProfile	获取群详细资料。
createGroup	创建群组。
dismissGroup	解散群组。
updateGroupProfile	修改群组资料。
joinGroup	申请加群。
quitGroup	退出群组。
searchGroupByID	搜索群组。
getGroupOnlineMemberCount	获取群在线人数。
changeGroupOwner	转让群组。
getGroupApplicationList	获取加群申请列表。
handleGroupApplication	处理申请加群。
initGroupAttributes	初始化群属性。
setGroupAttributes	设置群属性。
deleteGroupAttributes	删除群属性。
getGroupAttributes	获取群属性。
setGroupCounters	设置群计数器。
increaseGroupCounter	递增群计数器。
decreaseGroupCounter	递减群计数器。
getGroupCounters	获取群计数器。

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

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

Web & 小程序 & uni-app

本页目录：

TencentCloudChat

初始化

SDK 实例

事件相关

注册插件

设置日志级别

SDK 是否 ready

销毁 SDK 实例

登录相关

消息

会话

会话分组

搜索

资料

用户状态

关系链

关注和粉丝

群组

群成员

话题