>!**新老版本 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 | 描述 |
---|---|
addSignalingListener | 添加信令监听。 |
removeSignalingListener | 移除信令监听 |
invite | 邀请某个人。 |
inviteInGroup | 邀请群内的某些人 |
cancel | 邀请方取消邀请。 |
accept | 接收方接收邀请 |
reject | 接收方拒绝邀请。 |
getSignalingInfo | 获取信令信息。 |
addInvitedSignaling | 添加邀请信令(可以用于群离线推送消息触发的邀请信令)。 |
modifyInvitation | 修改邀请信令。 |
如果您需要收发图片、视频、文件等富媒体消息,并需要撤回消息、标记已读、查询历史消息等高级功能,推荐使用下面这套高级消息接口(简单消息接口和高级消息接口请不要混用)。
腾讯云 IM SDK 支持以下预设的群组类型,每种类型都有其适用场景:
社群用来管理群成员。社群下的所有话题不仅可以共享社群成员,还可以独立收发消息而不相互干扰。
API | 描述 |
---|---|
addCommunityListener | 添加社群监听器 |
removeCommunityListener | 移除社群监听器 |
createCommunity | 创建支持话题的社群 |
getJoinedCommunityList | 获取当前用户已经加入的支持话题的社群列表 |
createTopicInCommunity | 创建话题 |
deleteTopicFromCommunity | 删除话题 |
setTopicInfo | 修改话题信息 |
getTopicInfoList | 获取话题列表 |
createPermissionGroupInCommunity | 创建社群权限组 |
deletePermissionGroupFromCommunity | 删除社群权限组 |
modifyPermissionGroupInfoInCommunity | 修改社群权限组 |
getJoinedPermissionGroupListInCommunity | 获取已加入的社群权限组列表 |
getPermissionGroupListInCommunity | 获取社群权限组列表 |
addCommunityMembersToPermissionGroup | 向社群权限组添加成员 |
removeCommunityMembersFromPermissionGroup | 从社群权限组删除成员 |
getCommunityMemberListInPermissionGroup | 获取社群权限组成员列表 |
addTopicPermissionToPermissionGroup | 向权限组添加话题权限 |
deleteTopicPermissionFromPermissionGroup | 从权限组中删除话题权限 |
modifyTopicPermissionInPermissionGroup | 修改权限组中的话题权限 |
getTopicPermissionInPermissionGroup | 获取权限组中的话题权限 |
会话列表,即登录微信或 QQ 后首屏看到的列表,包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
API | 描述 |
---|---|
addConversationListener | 添加会话监听器 |
removeConversationListener | 移除会话监听器 |
getConversationList | 获取会话列表 |
getConversation | 获取指定单个会话 |
getConversationList | 获取指定多个会话 |
getConversationListByFilter | 获取会话列表(高级接口) |
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 | 获取黑名单列表 |
如果想要在 App 切后台时依然能够实时收到 IM 消息,可以使用离线推送服务。由于大陆境内尚没有统一的推送服务,Android 的离线推送需要针对不同厂商的手机进行 逐一适配。
API | 描述 |
---|---|
setOfflinePushConfig | 设置离线推送配置信息 |
doBackground | APP 检测到应用退后台时可以调用此接口 |
doForeground | APP 检测到应用进前台时可以调用此接口 |
腾讯云 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 | 检查指定用户的关注类型 |