注意:新老版本 API 请勿混合使用。
初始化并成功登录,是正常使用腾讯云 IM 服务的前提。
API | 描述 |
---|---|
initSDK | 初始化 |
unInitSDK | 反初始化 |
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 | 添加邀请信令(可以用于群离线推送消息触发的邀请信令)。 |
如果您需要收发图片、视频、文件等富媒体消息,并需要撤回消息、标记已读、查询历史消息等高级功能,推荐使用下面这套高级消息接口(简单消息接口和高级消息接口请不要混用)。
API | 描述 |
---|---|
addAdvancedMsgListener | 设置高级消息的事件监听器, 请不要同 addSimpleMsgListener 混用。 |
removeAdvancedMsgListener | 移除高级消息监听器 |
createTextMessage | 创建文本消息 |
createTextAtMessage | 创建 @ 文本消息 |
createCustomMessage | 创建自定义消息 |
createImageMessage | 创建图片消息 |
createSoundMessage | 创建语音消息 |
createVideoMessage | 创建视频消息 |
createFileMessage | 创建文件消息 |
createLocationMessage | 创建地理位置消息 |
createFaceMessage | 创建表情消息 |
createMergerMessage | 创建合并转发消息 |
createForwardMessage | 创建单条转发消息 |
sendMessage | 发送消息,消息对象可以由 createXXXMessage 接口创建得来。 |
setC2CReceiveMessageOpt | 设置单聊消息免打扰 |
getC2CReceiveMessageOpt | 获取单聊消息免打扰状态 |
setGroupReceiveMessageOpt | 设置群聊消息免打扰状态 |
getC2CHistoryMessageList | 获取单聊(C2C)历史消息 |
getGroupHistoryMessageList | 获取群组历史消息 |
getHistoryMessageList | 获取历史消息高级接口 |
revokeMessage | 撤回消息,消息对象可以由 createXXXMessage 接口创建得来。 |
markC2CMessageAsRead | 设置单聊(C2C)消息已读 |
markGroupMessageAsRead | 设置群组消息已读 |
deleteMessageFromLocalStorage | 删除本地消息 |
insertGroupMessageToLocalStorage | 向群组消息列表中添加一条消息 |
insertC2CMessageToLocalStorage | 向单聊消息列表中添加一条消息 |
findMessages | 根据 msgID 查找本地消息 |
腾讯云 IM SDK 支持四种预设的群组类型,每种类型都有其适用场景:
API | 描述 |
---|---|
setGroupListener | 设置群组监听器 |
createGroup | 创建群组(简单版本) |
createGroup | 创建群组(高级版本),可在建群同时设置群信息和初始的群成员 |
joinGroup | 加入群组 |
quitGroup | 退出群组 |
dismissGroup | 解散群组(仅群主和管理员可以解散) |
getJoinedGroupList | 获取已经加入的群列表(不包括已加入的直播群) |
getGroupsInfo | 拉取群资料 |
setGroupInfo | 修改群资料 |
initGroupAttributes | 初始化群属性 |
setGroupAttributes | 设置群属性 |
deleteGroupAttributes | 删除群属性 |
getGroupAttributes | 获取群属性 |
getGroupOnlineMemberCount | 获取群在线人数 |
getGroupMemberList | 获取群成员列表 |
getGroupMembersInfo | 获取指定的群成员资料 |
setGroupMemberInfo | 修改指定的群成员资料 |
muteGroupMember | 禁言 |
inviteUserToGroup | 邀请他人入群 |
kickGroupMember | 踢人 |
setGroupMemberRole | 切换群成员的角色 |
transferGroupOwner | 转让群主 |
getGroupApplicationList | 获取加群的申请列表 |
acceptGroupApplication | 同意某一条加群申请 |
refuseGroupApplication | 拒绝某一条加群申请 |
setGroupApplicationRead | 标记申请列表为已读 |
会话列表,即登录微信或 QQ 后首屏看到的列表,包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
API | 描述 |
---|---|
setConversationListener | 设置会话监听器 |
getConversationList | 获取会话列表 |
getConversation | 获取指定单个会话 |
getConversationList | 获取指定多个会话 |
deleteConversation | 删除会话 |
setConversationDraft | 设置会话草稿 |
pinConversation | 置顶会话 |
getTotalUnreadMessageCount | 获取会话总未读数 |
包含查询用户资料、修改个人资料以及屏蔽某人消息(即把某用户加入黑名单中)的相关接口。
API | 描述 |
---|---|
getUsersInfo | 获取用户资料 |
setSelfInfo | 修改个人资料 |
addToBlackList | 屏蔽某人的消息(添加该用户到黑名单中) |
deleteFromBlackList | 取消某人的消息屏蔽(把该用户从黑名单中移除) |
getBlackList | 获取黑名单列表 |
如果想要在 App 切后台时依然能够实时收到 IM 消息,可以使用离线推送服务,详细配置请参考 离线推送。
API | 描述 |
---|---|
setAPNSListener | 设置 APNs 监听 |
setAPNS | 设置离线推送配置信息 |
腾讯云 IM 在收发消息时默认不检查是不是好友关系,您可以在 【控制台】 >【功能配置】>【登录与消息】>【好友关系检查】中开启"发送单聊消息检查关系链"开关,并使用如下接口增删好友和管理好友列表。
API | 描述 |
---|---|
setFriendListener | 设置关系链与好友资料监听器 |
getFriendList | 获取好友列表 |
getFriendsInfo | 获取指定好友资料 |
setFriendInfo | 设置指定好友资料 |
addFriend | 添加好友 |
deleteFromFriendList | 删除好友 |
checkFriend | 检查指定用户的好友关系 |
getFriendApplicationList | 获取好友申请列表 |
acceptFriendApplication | 同意好友申请 |
refuseFriendApplication | 拒绝好友申请 |
deleteFriendApplication | 删除好友申请 |
setFriendApplicationRead | 设置好友申请已读 |
createFriendGroup | 新建好友分组 |
getFriendGroups | 获取分组信息 |
deleteFriendGroup | 删除好友分组 |
renameFriendGroup | 修改好友分组的名称 |
addFriendsToFriendGroup | 添加好友到一个好友分组 |
deleteFriendsFromFriendGroup | 从好友分组中删除好友 |
不管是 云主机 还是 云服务器 ,如今综合的理念就是节能环保,这个也是全世界所...
费用和两方面因素相关: 数据量:用户的数据量是业务决定的,无法优化。 配置:...
IntelliJ IDEA 最近发布了 20 周年庆典: https://www.jetbrains.com/lp/intelli...
驱动程序映射 现在我们了解了这种挂钩/通信方法的基础知识,所有其他对 MmGetPhy...
云存储 是在云计算(cloud computing)概念上延伸和发展出来的一个新的概念。 1、...
疫情之下,无论是头部企业开发者、中小型公司还是创业开发者,都愈发重视对运营...
如何查看应用组件部署失败的原因? 安装Agent失败 部署应用组件时无法选择已有负...
1.竞争惨烈 DRAM行业长期以来竞争就十分激烈。20世纪80年代,由于日本厂商控制了...
您可以通过控制台或者 API 对包年包月的专用宿主机实例进行续费。 通过 CDH 控制...
TOP云 (west.cn)3月29日消息,今天上午Donuts注册局亚太业务拓展总监Anand Vor...