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