- 动态与公告
- 产品简介
- 购买指南
- 开发指引
- Demo 专区
- 下载中心
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 推送功能
- 智能客服
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 开发指引
- Demo 专区
- 下载中心
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 推送功能
- 智能客服
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
注意
新老版本 API 请勿混合使用。
初始化登录接口
初始化并成功登录，是正常使用腾讯云 IM 服务的前提。
API | 描述 |
初始化 | |
反初始化 | |
添加 IM 监听 | |
移除 IM 监听 | |
获取版本号 | |
获取服务器当前时间 | |
登录 | |
退出登录 | |
获取登录用户 | |
获取登录状态 |
简单消息收发接口
如果您只需要使用文本和信令（即一段自定义buffer）消息，只需要使用这套简单消息收发接口即可。
API | 描述 |
移除基本消息（文本消息和自定义消息）的事件监听器 | |
发送单聊（C2C）普通文本消息 | |
发送单聊（C2C）自定义（信令）消息 | |
发送群聊普通文本消息 | |
发送群聊自定义（信令）消息 |
信令接口
API | 描述 |
添加信令监听 | |
移除信令监听 | |
邀请某个人 | |
邀请群内的某些人 | |
邀请方取消邀请 | |
接收方接收邀请 | |
接收方拒绝邀请 | |
获取信令信息 | |
添加邀请信令（可以用于群离线推送消息触发的邀请信令） | |
修改邀请信令 |
高级消息收发接口
如果您需要收发图片、视频、文件等富媒体消息，并需要撤回消息、标记已读、查询历史消息等高级功能，推荐使用下面这套高级消息接口（简单消息接口和高级消息接口请不要混用）。
API | 描述 |
移除高级消息监听器 | |
创建文本消息 | |
创建 @ 文本消息 | |
创建自定义消息 | |
创建图片消息 | |
创建语音消息 | |
创建视频消息 | |
创建文件消息 | |
创建地理位置消息 | |
创建表情消息 | |
创建合并转发消息 | |
创建单条转发消息 | |
创建定向群消息 | |
创建带 @ 标记的群消息 | |
发送消息，消息对象可以由 createXXXMessage 接口创建得来 | |
设置单聊消息免打扰 | |
获取单聊消息免打扰状态 | |
设置群聊消息免打扰状态 | |
获取单聊（C2C）历史消息 | |
获取群组历史消息 | |
获取历史消息高级接口 | |
撤回消息，消息对象可以由 createXXXMessage 接口创建得来 | |
消息变更 | |
设置单聊（C2C）消息已读 | |
设置群组消息已读 | |
标记所有会话为已读 | |
删除本地消息 | |
删除本地及云端的消息 | |
清空单聊本地及云端的消息 | |
清空群聊本地及云端的消息 | |
向群组消息列表中添加一条消息 | |
向单聊消息列表中添加一条消息 | |
根据 msgID 查找本地消息 | |
搜索本地消息 | |
发送消息已读回执 | |
获取消息已读回执 | |
获取群消息已读群成员列表 | |
设置消息扩展 | |
获取消息扩展 | |
删除消息扩展 | |
添加消息回应 | |
删除消息回应 | |
批量拉取多条消息回应 | |
分页拉取消息回应全量用户列表 | |
设置群消息置顶 | |
获取已置顶的群消息列表 |
群组相关接口
腾讯云 IM SDK 支持五种预设的群组类型，每种类型都有其适用场景：
工作群（Work） ：创建后不能自由加入，必须由已经在群的用户邀请入群，同旧版本中的 Private。
公开群（Public） ：用户申请加入，但需要群主或管理员审批。
会议群（Meeting）：适合跟 TRTC 结合实现视频会议和在线教育等场景，支持随意进出，支持查看进群前的历史消息，同旧版本中的 ChatRoom。
社群（Community）：创建后可以随意进出，适合用于知识分享和游戏交流等超大社区群聊场景。该功能支持终端 SDK 5.8.1668增强版及以上版本、Web SDK 2.17.0及以上版本，需 购买进阶版 并在 控制台 >功能配置>群组配置>群功能配置>社群中开通。
直播群（AVChatRoom）：适合直播弹幕聊天室等场景，支持随意进出，人数无上限。
API | 描述 |
设置群组监听器（待废弃接口，请使用 addGroupListener 和 removeGroupListener 接口） | |
添加群组监听器 | |
移除群组监听器 | |
创建群组（简单版本） | |
创建群组（高级版本），可在建群同时设置群信息和初始的群成员 | |
加入群组 | |
退出群组 | |
解散群组（仅群主和管理员可以解散） | |
获取已经加入的群列表（不包括已加入的直播群） | |
拉取群资料 | |
搜索群列表 | |
修改群资料 | |
初始化群属性 | |
设置群属性 | |
删除群属性 | |
获取群属性 | |
获取群在线人数 | |
获取群成员列表 | |
获取指定的群成员资料 | |
搜索指定的群成员资料 | |
修改指定的群成员资料 | |
禁言 | |
邀请他人入群 | |
踢人 | |
切换群成员的角色 | |
标记群成员 | |
转让群主 | |
获取加群的申请列表 | |
同意某一条加群申请 | |
拒绝某一条加群申请 | |
标记申请列表为已读 | |
获取当前用户已经加入的支持话题的社群列表 | |
创建话题 | |
删除话题 | |
修改话题信息 | |
获取话题列表 |
会话列表相关接口
会话列表，即登录后首屏看到的列表，包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
API | 描述 |
设置会话监听器 （待废弃接口，请使用 addConversationListener 和 removeConversationListener 接口） | |
添加会话监听器 | |
移除会话监听器 | |
获取会话列表 | |
获取指定单个会话 | |
获取指定多个会话 | |
获取会话高级接口，可以指定会话类型、标记类型、分组名等 | |
删除会话 | |
设置会话草稿 | |
设置会话自定义数据 | |
置顶会话 | |
标记会话 | |
获取会话总未读数 | |
创建会话分组 | |
获取会话分组列表 | |
删除会话分组 | |
重命名会话分组 | |
添加会话到一个会话分组 | |
从一个会话分组中删除会话 |
用户资料相关接口
包含查询用户资料、修改个人资料以及屏蔽某人消息（即把某用户加入黑名单中）的相关接口。
API | 描述 |
获取用户资料 | |
修改个人资料 | |
查询用户状态 | |
设置自己的状态 | |
订阅用户状态 | |
取消订阅用户状态 | |
屏蔽某人的消息（添加该用户到黑名单中） | |
取消某人的消息屏蔽（把该用户从黑名单中移除） | |
获取黑名单列表 |
离线推送相关接口
如果想要在 App 切后台时依然能够实时收到 IM 消息，可以使用离线推送服务。
API | 描述 |
设置 APNs 监听 | |
配置 APNS 推送信息 | |
配置 VOIP 推送信息 |
好友管理相关接口
API | 描述 |
设置关系链与好友资料监听器（待废弃接口，请使用 addFriendListener 和 removeFriendListener 接口） | |
添加关系链监听器 | |
移除关系链监听器 | |
获取好友列表 | |
获取指定好友资料 | |
设置指定好友资料 | |
搜索好友列表 | |
添加好友 | |
删除好友 | |
检查指定用户的好友关系 | |
获取好友申请列表 | |
同意好友申请 | |
拒绝好友申请 | |
删除好友申请 | |
设置好友申请已读 | |
新建好友分组 | |
获取分组信息 | |
删除好友分组 | |
修改好友分组的名称 | |
添加好友到一个好友分组 | |
从好友分组中删除好友 |
是
否
本页内容是否解决了您的问题？