>!**新老版本 API 请勿混合使用**。
初始化并成功登录,是正常使用腾讯云 IM 服务的前提。
| API | 描述 |
|---|---|
| InitSDK | 初始化 SDK |
| UnInitSDK | 反初始化 SDK |
| AddSDKListener | 添加 IM 监听 |
| RemoveSDKListener | 移除 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 | 获取会话总未读数 |
| CleanConversationUnreadMessageCount | 清理会话的未读消息计数 |
| CreateConversationGroup | 创建会话分组 |
| GetConversationGroupList | 获取会话分组列表 |
| DeleteConversationGroup | 删除会话分组 |
| RenameConversationGroup | 重命名会话分组 |
| AddConversationsToGroup | 添加会话到一个会话分组 |
| DeleteConversationsFromGroup | 从一个会话分组中删除会话 |
| GetUnreadMessageCountByFilter | 获取按会话 filter 过滤的未读总数 |
| SubscribeUnreadMessageCountByFilter | 注册监听指定 filter 的会话未读总数变化 |
| UnsubscribeUnreadMessageCountByFilter | 取消监听指定 filter 的会话未读总数变化 |
包含查询用户资料、修改个人资料以及屏蔽某人消息(即把某用户加入黑名单中)的相关接口。
| 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 | 从好友分组中删除好友 |
公众号可以为订阅的用户发送广播消息,也可以与订阅的用户进行单聊。
| API | 描述 |
|---|---|
| SubscribeOfficialAccount | 订阅公众号 |
| UnsubscribeOfficialAccount | 取消订阅公众号 |
| GetOfficialAccountsInfo | 获取公众号列表 |
关注和粉丝功能可以帮助建立和维护用户之间相对简单的连接关系,方便促进用户之间的互动和交流。
| API | 描述 |
|---|---|
| FollowUser | 关注用户 |
| UnfollowUser | 取消关注用户 |
| GetMyFollowingList | 获取我的关注列表 |
| GetMyFollowersList | 获取我的粉丝列表 |
| GetMutualFollowersList | 获取我的互关列表 |
| GetUserFollowInfo | 获取指定用户的 关注/粉丝/互关 数量信息 |
| CheckFollowType | 检查指定用户的关注类型 |
点此进入 IM 社群,享有专业工程师的支持,解决您的难题。