即时通信 IM HarmonyOS-客户端 API-文档中心-腾讯云

初始化登录接口
初始化并成功登录，是正常使用腾讯云 IM 服务的前提。
API
描述
﻿initSDK﻿
初始化 SDK。
﻿unInitSDK﻿
反初始化 SDK。
﻿addIMSDKListener﻿
添加 IM 监听。
﻿removeIMSDKListener﻿
移除 IM 监听。
﻿getVersion﻿
获取版本号。
﻿getServerTime﻿
获取服务器当前时间。
﻿login﻿
登录。
﻿logout﻿
登出。
﻿getLoginStatus﻿
获取登录状态。
﻿getLoginUser﻿
获取当前登录用户的 UserID。
简单消息收发接口
如果您只需要使用文本和信令（即一段自定义buffer）消息，只需要使用这套简单消息收发接口即可。
API
描述
﻿addSimpleMsgListener﻿
设置基本消息（文本消息和自定义消息）的事件监听器，请不要同  addAdvancedMsgListener  混用。
﻿removeSimpleMsgListener﻿
移除基本消息（文本消息和自定义消息）的事件监听器。
﻿sendC2CTextMessage﻿
发送单聊（C2C）普通文本消息。
﻿sendC2CCustomMessage﻿
发送单聊（C2C）自定义（信令）消息。
﻿sendGroupTextMessage﻿
发送群聊普通文本消息。
﻿sendGroupCustomMessage﻿
发送群聊自定义（信令）消息。
高级消息收发接口
如果您需要收发图片、视频、文件等富媒体消息，并需要撤回消息、标记已读、查询历史消息等高级功能，推荐使用下面这套高级消息接口（简单消息接口和高级消息接口请不要混用）。
API
描述
﻿addAdvancedMsgListener﻿
设置高级消息的事件监听器，请不要同 addSimpleMsgListener 混用。
﻿removeAdvancedMsgListener﻿
移除高级消息的事件监听器。
﻿createTextMessage﻿
创建文本消息。
﻿createCustomMessage﻿
创建自定义消息。
﻿createImageMessage﻿
创建图片消息。
﻿createSoundMessage﻿
创建语音消息。
﻿createVideoMessage﻿
创建视频消息。
﻿createFileMessage﻿
创建文件消息。
﻿createLocationMessage﻿
创建地理位置消息。
﻿createFaceMessage﻿
创建表情消息。
﻿createMergerMessage﻿
创建合并转发消息。
﻿createForwardMessage﻿
创建单条转发消息。
﻿createTargetedGroupMessage﻿
创建定向群消息。
﻿createAtSignedGroupMessage﻿
创建带 @ 标记的群消息。
﻿sendMessage﻿
发送消息，消息对象可以由 createXXXMessage 接口创建得来。
﻿setC2CReceiveMessageOpt﻿
设置单聊消息免打扰。
﻿getC2CReceiveMessageOpt﻿
获取单聊消息免打扰状态。
﻿setGroupReceiveMessageOpt﻿
设置群聊消息免打扰状态。
﻿setAllReceiveMessageOpt﻿
设置全局消息接收选项。
﻿setAllReceiveMessageOpt2﻿
设置全局消息接收选项。
﻿getAllReceiveMessageOpt﻿
 获取登录用户全局消息接收选项。
﻿getHistoryMessageList﻿
获取历史消息高级接口。
﻿revokeMessage﻿
撤回消息，消息对象可以由 createXXXMessage 接口创建得来。
﻿modifyMessage﻿
消息变更。
﻿deleteMessages﻿
删除本地及云端的消息。
﻿clearC2CHistoryMessage﻿
清空单聊本地及云端的消息。
﻿clearGroupHistoryMessage﻿
清空群聊本地及云端的消息。
﻿insertGroupMessageToLocalStorage﻿
向群组消息列表中添加一条消息。
﻿insertC2CMessageToLocalStorage﻿
向单聊消息列表中添加一条消息。
﻿findMessages﻿
根据 msgID 查找本地消息。
﻿searchLocalMessages﻿
搜索本地消息。
﻿searchCloudMessages﻿
搜索云端消息。
﻿sendMessageReadReceipts﻿
发送消息已读回执。
getMessageReadReceipts
获取消息已读回执。
getGroupMessageReadMemberList
获取群消息已读群成员列表。
setMessageExtensions
设置消息扩展。
﻿getMessageExtensions﻿
获取消息扩展。
﻿deleteMessageExtensions﻿
删除消息扩展。
﻿addMessageReaction﻿
添加消息回应。
﻿removeMessageReaction﻿
删除消息回应。
﻿getMessageReactions﻿
批量拉取多条消息回应信息。
﻿getMessageReactionUserList﻿
分页拉取消息回应全部用户资料。
﻿translateText﻿
翻译文本消息。
﻿pinGroupMessage﻿
设置群消息置顶。
﻿getPinnedGroupMessageList﻿
获取已置顶的群消息列表。
群组相关接口
腾讯云 IM SDK 支持五种预设的群组类型，每种类型都有其适用场景：
工作群（Work）：类似普通微信群，创建后不能自由加入，必须由已经在群的用户邀请入群，同旧版本中的 Private。
公开群（Public）：类似 QQ 群，用户申请加入，但需要群主或管理员审批。
会议群（Meeting）：适合跟 TRTC 结合实现视频会议和在线教育等场景，支持随意进出，支持查看进群前的历史消息，同旧版本中的 ChatRoom。
社群（Community）：创建后可以随意进出，适合用于知识分享和游戏交流等超大社区群聊场景。该功能支持终端 SDK 5.8.1668增强版及以上版本、Web SDK 2.17.0及以上版本，需 购买旗舰版套餐包 并在 控制台 > 功能配置 > 群组配置 > 群功能配置 > 社群中开通。
直播群（AVChatRoom）：适合直播弹幕聊天室等场景，支持随意进出，人数无上限。
API
描述
﻿addGroupListener﻿
添加群组监听器。
﻿removeGroupListener﻿
移除群组监听器。
﻿createGroup﻿
创建群组（简单版本）。
﻿createGroup﻿
创建群组（高级版本），可在建群同时设置群信息和初始的群成员。
﻿joinGroup﻿
加入群组。
﻿quitGroup﻿
退出群组。
﻿dismissGroup﻿
解散群组（仅群主和管理员可以解散）。
﻿getJoinedGroupList﻿
获取已经加入的群列表（不包括已加入的直播群）。
﻿getGroupsInfo﻿
拉取群资料。
﻿searchGroups﻿
搜索群列表。
﻿setGroupInfo﻿
修改群资料。
﻿initGroupAttributes﻿
初始化群属性。
﻿setGroupAttributes﻿
设置群属性。
﻿deleteGroupAttributes﻿
删除群属性。
﻿getGroupAttributes﻿
获取群属性。
﻿getGroupOnlineMemberCount﻿
获取群在线人数。
﻿setGroupCounters﻿
设置群计数器。
﻿getGroupCounters﻿
获取群计数器。
﻿increaseGroupCounter﻿
递增群计数器。
﻿decreaseGroupCounter﻿
递减群计数器。
﻿getGroupMemberList﻿
获取群成员列表。
﻿getGroupMembersInfo﻿
获取指定的群成员资料。
﻿searchGroupMembers﻿
搜索群成员。
﻿setGroupMemberInfo﻿
修改指定的群成员资料。
﻿muteGroupMember﻿
禁言。
﻿muteAllGroupMembers﻿
禁言全体群成员。
﻿inviteUserToGroup﻿
邀请他人入群。
﻿kickGroupMember﻿
踢人。
﻿setGroupMemberRole﻿
切换群成员的角色。
﻿markGroupMemberList﻿
标记群成员。
﻿transferGroupOwner﻿
转让群主。
﻿getGroupApplicationList﻿
获取加群的申请列表。
﻿acceptGroupApplication﻿
同意某一条加群申请。
﻿refuseGroupApplication﻿
拒绝某一条加群申请。
﻿setGroupApplicationRead﻿
标记申请列表为已读。
会话列表相关接口
会话列表，即登录微信或 QQ 后首屏看到的列表，包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
API
描述
﻿addConversationListener﻿
添加会话监听器。
﻿removeConversationListener﻿
移除会话监听器。
﻿getConversations﻿
获取会话列表。
﻿getConversationListByFilter﻿
获取会话高级接口，可以指定会话类型、标记类型、分组名等。
﻿getConversation﻿
获取指定单个会话。
﻿deleteConversation﻿
删除会话。
﻿deleteConversationList﻿
删除会话列表。
﻿setConversationDraft﻿
设置会话草稿。
﻿setConversationCustomData﻿
设置会话自定义数据。
﻿pinConversation﻿
置顶会话。
﻿markConversation﻿
标记会话。
﻿getTotalUnreadMessageCount﻿
获取会话总未读数。
﻿getUnreadMessageCountByFilter﻿
获取按会话 filter 过滤的未读总数。
﻿subscribeUnreadMessageCountByFilter﻿
注册监听指定 filter 的会话未读总数变化。
﻿unsubscribeUnreadMessageCountByFilter﻿
取消监听指定 filter 的会话未读总数变化。
﻿cleanConversationUnreadMessageCount﻿
清理会话的未读消息计数。
﻿createConversationGroup﻿
创建会话分组。
﻿getConversationGroupList﻿
获取会话分组列表。
﻿deleteConversationGroup﻿
删除会话分组。
﻿renameConversationGroup﻿
重命名会话分组。
﻿addConversationsToGroup﻿
添加会话到一个会话分组。
﻿deleteConversationsFromGroup﻿
从一个会话分组中删除会话。
用户资料相关接口
包含查询用户资料、修改个人资料以及屏蔽某人消息（即把某用户加入黑名单中）的相关接口。
API
描述
﻿getUsersInfo﻿
获取用户资料。
﻿setSelfInfo﻿
修改个人资料。
﻿subscribeUserInfo﻿
订阅用户资料。
﻿unsubscribeUserInfo﻿
取消订阅用户资料。
﻿getUserStatus﻿
查询用户状态。
﻿setSelfStatus﻿
设置自己的状态。
﻿subscribeUserStatus﻿
订阅用户状态。
﻿unsubscribeUserStatus﻿
取消订阅用户状态。
﻿addToBlackList﻿
屏蔽某人的消息（添加该用户到黑名单中）。
﻿deleteFromBlackList﻿
取消某人的消息屏蔽（把该用户从黑名单中移除）。
﻿getBlackList﻿
获取黑名单列表。
好友管理相关接口
腾讯云 IM 在收发消息时默认不检查是不是好友关系，您可以在 控制台 >功能配置>登录与消息>好友关系检查中开启"发送单聊消息检查关系链"开关，并使用如下接口增删好友和管理好友列表。
API
描述
﻿addFriendListener﻿
添加关系链监听器。
﻿removeFriendListener﻿
移除关系链监听器。
﻿getFriendList﻿
获取好友列表。
﻿getFriendsInfo﻿
获取指定好友资料。
﻿setFriendInfo﻿
设置指定好友资料。
﻿searchFriends﻿
搜索好友列表。
﻿addFriend﻿
添加好友。
﻿deleteFromFriendList﻿
删除好友。
﻿checkFriend﻿
检查指定用户的好友关系。
﻿getFriendApplicationList﻿
获取好友申请列表。
﻿acceptFriendApplication﻿
同意好友申请。
﻿refuseFriendApplication﻿
拒绝好友申请。
﻿deleteFriendApplication﻿
删除好友申请。
﻿setFriendApplicationRead﻿
设置好友申请已读。
﻿createFriendGroup﻿
新建好友分组。
﻿getFriendGroups﻿
获取分组信息。
﻿deleteFriendGroup﻿
删除好友分组。
﻿renameFriendGroup﻿
修改好友分组的名称。
﻿addFriendsToFriendGroup﻿
添加好友到一个好友分组。
﻿deleteFriendsFromFriendGroup﻿
从好友分组中删除好友。
﻿subscribeOfficialAccount﻿
订阅公众号。
﻿unsubscribeOfficialAccount﻿
取消订阅公众号。
﻿getOfficialAccountsInfo﻿
获取公众号列表。
﻿followUser﻿
关注用户。
﻿unfollowUser﻿
取消关注用户。
﻿getMyFollowingList﻿
获取我的关注列表。
﻿getMyFollowersList﻿
获取我的粉丝列表。
﻿getMutualFollowersList﻿
获取我的互关列表。
﻿getUserFollowInfo﻿
获取指定用户的 关注/粉丝/互关 数量信息。
﻿checkFollowType﻿
检查指定用户的关注类型。
信令相关接口
API
描述
﻿addSignalingListener﻿
添加信令监听。
﻿removeSignalingListener﻿
移除信令监听。
﻿invite﻿
邀请某个人。
﻿inviteInGroup﻿
邀请群内的某些人。
﻿cancel﻿
邀请方取消邀请。
﻿accept﻿
接收方接收邀请。
﻿reject﻿
接收方拒绝邀请。
﻿getSignalingInfo﻿
获取信令信息。
﻿modifyInvitation﻿
修改邀请信令。
社群相关接口
API
描述
﻿addCommunityListener﻿
添加社群监听器。
﻿removeCommunityListener﻿
移除社群监听器。
﻿createCommunity﻿
创建支持话题的社群。
﻿getJoinedCommunityList﻿
获取当前用户已经加入的支持话题的社群列表。
﻿createTopicInCommunity﻿
创建话题。
﻿deleteTopicFromCommunity﻿
删除话题。
﻿setTopicInfo﻿
修改话题信息。
﻿getTopicInfoList﻿
获取话题列表。
﻿createPermissionGroupInCommunity﻿
创建社群权限组。
﻿deletePermissionGroupFromCommunity﻿
删除社群权限组
﻿modifyPermissionGroupInfoInCommunity﻿
修改社群权限组。
﻿getJoinedPermissionGroupListInCommunity﻿
获取已加入的社群权限组列表。
﻿getPermissionGroupListInCommunity﻿
获取社群权限组列表。
﻿addCommunityMembersToPermissionGroup﻿
向社群权限组添加成员。
﻿removeCommunityMembersFromPermissionGroup﻿
从社群权限组删除成员。
﻿getCommunityMemberListInPermissionGroup﻿
获取社群权限组成员列表。
﻿addTopicPermissionToPermissionGroup﻿
向权限组添加话题权限。
﻿deleteTopicPermissionFromPermissionGroup﻿
从权限组中删除话题权限。
﻿modifyTopicPermissionInPermissionGroup﻿
修改权限组中的话题权限。
﻿getTopicPermissionInPermissionGroup﻿
获取权限组中的话题权限。
交流与反馈
﻿点此进入 IM 社群，享有专业工程师的支持，解决您的难题。
相关链接
﻿下载 IM SDK（HarmonyOS）﻿
﻿集成 IM SDK（HarmonyOS）﻿
﻿运行 IM Demo（HarmonyOS）﻿
﻿

API	描述
initSDK	初始化 SDK。
unInitSDK	反初始化 SDK。
addIMSDKListener	添加 IM 监听。
removeIMSDKListener	移除 IM 监听。
getVersion	获取版本号。
getServerTime	获取服务器当前时间。
login	登录。
logout	登出。
getLoginStatus	获取登录状态。
getLoginUser	获取当前登录用户的 UserID。

API	描述
addSimpleMsgListener	设置基本消息（文本消息和自定义消息）的事件监听器，请不要同 addAdvancedMsgListener 混用。
removeSimpleMsgListener	移除基本消息（文本消息和自定义消息）的事件监听器。
sendC2CTextMessage	发送单聊（C2C）普通文本消息。
sendC2CCustomMessage	发送单聊（C2C）自定义（信令）消息。
sendGroupTextMessage	发送群聊普通文本消息。
sendGroupCustomMessage	发送群聊自定义（信令）消息。

API	描述
addAdvancedMsgListener	设置高级消息的事件监听器，请不要同 addSimpleMsgListener 混用。
removeAdvancedMsgListener	移除高级消息的事件监听器。
createTextMessage	创建文本消息。
createCustomMessage	创建自定义消息。
createImageMessage	创建图片消息。
createSoundMessage	创建语音消息。
createVideoMessage	创建视频消息。
createFileMessage	创建文件消息。
createLocationMessage	创建地理位置消息。
createFaceMessage	创建表情消息。
createMergerMessage	创建合并转发消息。
createForwardMessage	创建单条转发消息。
createTargetedGroupMessage	创建定向群消息。
createAtSignedGroupMessage	创建带 @ 标记的群消息。
sendMessage	发送消息，消息对象可以由 createXXXMessage 接口创建得来。
setC2CReceiveMessageOpt	设置单聊消息免打扰。
getC2CReceiveMessageOpt	获取单聊消息免打扰状态。
setGroupReceiveMessageOpt	设置群聊消息免打扰状态。
setAllReceiveMessageOpt	设置全局消息接收选项。
setAllReceiveMessageOpt2	设置全局消息接收选项。
getAllReceiveMessageOpt	获取登录用户全局消息接收选项。
getHistoryMessageList	获取历史消息高级接口。
revokeMessage	撤回消息，消息对象可以由 createXXXMessage 接口创建得来。
modifyMessage	消息变更。
deleteMessages	删除本地及云端的消息。
clearC2CHistoryMessage	清空单聊本地及云端的消息。
clearGroupHistoryMessage	清空群聊本地及云端的消息。
insertGroupMessageToLocalStorage	向群组消息列表中添加一条消息。
insertC2CMessageToLocalStorage	向单聊消息列表中添加一条消息。
findMessages	根据 msgID 查找本地消息。
searchLocalMessages	搜索本地消息。
searchCloudMessages	搜索云端消息。
sendMessageReadReceipts	发送消息已读回执。
getMessageReadReceipts	获取消息已读回执。
getGroupMessageReadMemberList	获取群消息已读群成员列表。
setMessageExtensions	设置消息扩展。
getMessageExtensions	获取消息扩展。
deleteMessageExtensions	删除消息扩展。
addMessageReaction	添加消息回应。
removeMessageReaction	删除消息回应。
getMessageReactions	批量拉取多条消息回应信息。
getMessageReactionUserList	分页拉取消息回应全部用户资料。
translateText	翻译文本消息。
pinGroupMessage	设置群消息置顶。
getPinnedGroupMessageList	获取已置顶的群消息列表。

API	描述
addGroupListener	添加群组监听器。
removeGroupListener	移除群组监听器。
createGroup	创建群组（简单版本）。
createGroup	创建群组（高级版本），可在建群同时设置群信息和初始的群成员。
joinGroup	加入群组。
quitGroup	退出群组。
dismissGroup	解散群组（仅群主和管理员可以解散）。
getJoinedGroupList	获取已经加入的群列表（不包括已加入的直播群）。
getGroupsInfo	拉取群资料。
searchGroups	搜索群列表。
setGroupInfo	修改群资料。
initGroupAttributes	初始化群属性。
setGroupAttributes	设置群属性。
deleteGroupAttributes	删除群属性。
getGroupAttributes	获取群属性。
getGroupOnlineMemberCount	获取群在线人数。
setGroupCounters	设置群计数器。
getGroupCounters	获取群计数器。
increaseGroupCounter	递增群计数器。
decreaseGroupCounter	递减群计数器。
getGroupMemberList	获取群成员列表。
getGroupMembersInfo	获取指定的群成员资料。
searchGroupMembers	搜索群成员。
setGroupMemberInfo	修改指定的群成员资料。
muteGroupMember	禁言。
muteAllGroupMembers	禁言全体群成员。
inviteUserToGroup	邀请他人入群。
kickGroupMember	踢人。
setGroupMemberRole	切换群成员的角色。
markGroupMemberList	标记群成员。
transferGroupOwner	转让群主。
getGroupApplicationList	获取加群的申请列表。
acceptGroupApplication	同意某一条加群申请。
refuseGroupApplication	拒绝某一条加群申请。
setGroupApplicationRead	标记申请列表为已读。

API	描述
addConversationListener	添加会话监听器。
removeConversationListener	移除会话监听器。
getConversations	获取会话列表。
getConversationListByFilter	获取会话高级接口，可以指定会话类型、标记类型、分组名等。
getConversation	获取指定单个会话。
deleteConversation	删除会话。
deleteConversationList	删除会话列表。
setConversationDraft	设置会话草稿。
setConversationCustomData	设置会话自定义数据。
pinConversation	置顶会话。
markConversation	标记会话。
getTotalUnreadMessageCount	获取会话总未读数。
getUnreadMessageCountByFilter	获取按会话 filter 过滤的未读总数。
subscribeUnreadMessageCountByFilter	注册监听指定 filter 的会话未读总数变化。
unsubscribeUnreadMessageCountByFilter	取消监听指定 filter 的会话未读总数变化。
cleanConversationUnreadMessageCount	清理会话的未读消息计数。
createConversationGroup	创建会话分组。
getConversationGroupList	获取会话分组列表。
deleteConversationGroup	删除会话分组。
renameConversationGroup	重命名会话分组。
addConversationsToGroup	添加会话到一个会话分组。
deleteConversationsFromGroup	从一个会话分组中删除会话。

API	描述
getUsersInfo	获取用户资料。
setSelfInfo	修改个人资料。
subscribeUserInfo	订阅用户资料。
unsubscribeUserInfo	取消订阅用户资料。
getUserStatus	查询用户状态。
setSelfStatus	设置自己的状态。
subscribeUserStatus	订阅用户状态。
unsubscribeUserStatus	取消订阅用户状态。
addToBlackList	屏蔽某人的消息（添加该用户到黑名单中）。
deleteFromBlackList	取消某人的消息屏蔽（把该用户从黑名单中移除）。
getBlackList	获取黑名单列表。

API	描述
addFriendListener	添加关系链监听器。
removeFriendListener	移除关系链监听器。
getFriendList	获取好友列表。
getFriendsInfo	获取指定好友资料。
setFriendInfo	设置指定好友资料。
searchFriends	搜索好友列表。
addFriend	添加好友。
deleteFromFriendList	删除好友。
checkFriend	检查指定用户的好友关系。
getFriendApplicationList	获取好友申请列表。
acceptFriendApplication	同意好友申请。
refuseFriendApplication	拒绝好友申请。
deleteFriendApplication	删除好友申请。
setFriendApplicationRead	设置好友申请已读。
createFriendGroup	新建好友分组。
getFriendGroups	获取分组信息。
deleteFriendGroup	删除好友分组。
renameFriendGroup	修改好友分组的名称。
addFriendsToFriendGroup	添加好友到一个好友分组。
deleteFriendsFromFriendGroup	从好友分组中删除好友。
subscribeOfficialAccount	订阅公众号。
unsubscribeOfficialAccount	取消订阅公众号。
getOfficialAccountsInfo	获取公众号列表。
followUser	关注用户。
unfollowUser	取消关注用户。
getMyFollowingList	获取我的关注列表。
getMyFollowersList	获取我的粉丝列表。
getMutualFollowersList	获取我的互关列表。
getUserFollowInfo	获取指定用户的关注/粉丝/互关数量信息。
checkFollowType	检查指定用户的关注类型。

API	描述
addSignalingListener	添加信令监听。
removeSignalingListener	移除信令监听。
invite	邀请某个人。
inviteInGroup	邀请群内的某些人。
cancel	邀请方取消邀请。
accept	接收方接收邀请。
reject	接收方拒绝邀请。
getSignalingInfo	获取信令信息。
modifyInvitation	修改邀请信令。

API	描述
addCommunityListener	添加社群监听器。
removeCommunityListener	移除社群监听器。
createCommunity	创建支持话题的社群。
getJoinedCommunityList	获取当前用户已经加入的支持话题的社群列表。
createTopicInCommunity	创建话题。
deleteTopicFromCommunity	删除话题。
setTopicInfo	修改话题信息。
getTopicInfoList	获取话题列表。
createPermissionGroupInCommunity	创建社群权限组。
deletePermissionGroupFromCommunity	删除社群权限组
modifyPermissionGroupInfoInCommunity	修改社群权限组。
getJoinedPermissionGroupListInCommunity	获取已加入的社群权限组列表。
getPermissionGroupListInCommunity	获取社群权限组列表。
addCommunityMembersToPermissionGroup	向社群权限组添加成员。
removeCommunityMembersFromPermissionGroup	从社群权限组删除成员。
getCommunityMemberListInPermissionGroup	获取社群权限组成员列表。
addTopicPermissionToPermissionGroup	向权限组添加话题权限。
deleteTopicPermissionFromPermissionGroup	从权限组中删除话题权限。
modifyTopicPermissionInPermissionGroup	修改权限组中的话题权限。
getTopicPermissionInPermissionGroup	获取权限组中的话题权限。

HarmonyOS

本页目录：

初始化登录接口

简单消息收发接口

高级消息收发接口

群组相关接口

会话列表相关接口

用户资料相关接口

好友管理相关接口

信令相关接口

社群相关接口

交流与反馈

相关链接