即时通信 IM
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>即时通信 IM>客户端 API>Flutter

Flutter

最近更新时间：2024-02-27 14:08:21

我的收藏

本页目录：

温馨提示：
即时通信 IM 为您准备了 Flutter 的 API 调用示例，您可以访问 GitHub 获取源码。

初始化登录接口

初始化并成功登录，是正常使用腾讯云 IM 服务的前提。
API
描述
初始化 SDK
反初始化 SDK
登录
登出
获取当前登录用户的 UserID
获取登录状态
获取服务器当前时间（Web不支持）
获取版本号
会话功能模块
关系链功能模块
高级群组功能模块
高级消息功能模块
离线推送模块
信令模块

信令接口

API
描述
添加信令监听
移除信令监听
邀请某个人
邀请群内的某些人
邀请方取消邀请
接收方接受邀请
接收方拒绝邀请
获取信令信息
创建一个信令请求

创建消息接口

创建的消息会返回一个id字段，将id字段等传递给统一的发送接口（sendMessage）即可发送消息。
API
描述
创建文本消息
创建定制化消息
创建图片消息
创建音频文件
创建视频文件
创建AT消息
创建文件消息
创建位置信息
创建表情消息
创建合并消息
创建转发消息
创建一条定向群消息
添加多Element消息

消息收发接口

如果您需要收发图片、视频、文件等富媒体消息，并需要撤回消息、标记已读、查询历史消息等高级功能，推荐使用下面这套高级消息接口（原3.6.0前的高级消息部分接口已弃用，请使用新版创建消息接口后调用发送消息接口）。
API
描述
设置高级消息的事件监听器
移除高级消息的事件监听器
获取单聊（C2C）历史消息
获取历史消息高级接口
获取群组历史消息
设置单聊（C2C）消息已读
设置群组消息已读
标记所有消息为已读
删除本地消息
删除本地及漫游消息
向群组消息列表中添加一条消息
向C2C消息列表中添加一条消息
清空单聊本地及云端的消息（不删除会话）
清空群组及云端的消息（不删除会话）
获取合并消息的子消息
消息重发
设置针对某个用户的 C2C 消息接收选项（支持批量设置）
查询针对某个用户的 C2C 消息接收选项
修改群消息接收选项
设置消息自定义数据（本地保存，不会发送到对端，程序卸载重装后失效）
设置消息自定义数据，可以用来标记语音、视频消息是否已经播放（本地保存，不会发送到对端，程序卸载重装后失效）
撤回消息的时间限制默认 2 minutes，超过 2 minutes 的消息不能撤回，您也可以在 控制台（功能配置 -> 登录与消息 -> 消息撤回设置）自定义撤回时间限制。
消息变更
发送消息
发送回复消息
搜索本地消息
发送群消息已读回执
获取自己发送消息的已读回执
获取自己发送的群消息已读（未读）群成员列表

群组相关接口

腾讯云 IM SDK 支持五种预设的群组类型，每种类型都有其适用场景：
工作群（Work） ：类似普通微信群，创建后不能自由加入，必须由已经在群的用户邀请入群，同旧版本中的 Private。
公开群（Public） ：类似 QQ 群，用户申请加入，但需要群主或管理员审批。
会议群（Meeting）：适合跟 TRTC 结合实现视频会议和在线教育等场景，支持随意进出，支持查看进群前的历史消息，同旧版本中的 ChatRoom。
社群（Community）：创建后可以随意进出，适合用于知识分享和游戏交流等超大社区群聊场景。
直播群（AVChatRoom）：适合直播弹幕聊天室等场景，支持随意进出，人数无上限。
API
描述
添加群组监听器
设置群组相关的事件监听器
移除群组监听器
创建群组（高级版本），可在建群同时设置群信息和初始的群成员
加入群组
退出群组
解散群组（仅群主和管理员可以解散）
获取已经加入的群列表（不包括已加入的直播群）
拉取群资料
修改群资料
初始化群属性，会清空原有的群属性列表
设置群属性。已有该群属性则更新其 value 值，没有该群属性则添加该属性。
删除指定群属性，keys 传 null 则清空所有群属性。
获取指定群属性，keys 传 null 则获取所有群属性。
搜索群列表
获取指定群在线人数(目前只支持直播群)
获取群成员列表
获取指定的群成员资料
修改指定的群成员资料
搜索群成员
禁言
踢人
切换群成员的角色
转让群主
邀请他人入群
获取加群的申请列表
同意某一条加群申请
拒绝某一条加群申请
标记申请列表为已读
获取当前用户已经加入的支持话题的社群列表
创建话题
删除话题
设置话题属性
获取话题属性的列表

会话列表相关接口

会话列表，即登录微信或 QQ 后首屏看到的列表，包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
API
描述
添加关系链监听器
移除关系链监听器
设置会话监听器
获取会话列表
通过会话ID获取指定会话列表
会话置顶
获取会话未读总数
获取指定会话
删除会话
设置会话草稿

用户资料相关接口

包含查询用户资料、修改个人资料以及屏蔽某人消息（即把某用户加入黑名单中）的相关接口。
API
描述
获取用户资料
获取用户在线状态
修改个人资料
设置当前登录用户在线状态
屏蔽某人的消息（添加该用户到黑名单中）
取消某人的消息屏蔽（把该用户从黑名单中移除）
获取黑名单列表

离线推送相关接口

如果想要在 App 切后台时依然能够实时收到 IM 消息，可以使用离线推送服务。由于大陆境内尚没有统一的推送服务，Android 的离线推送需要针对不同厂商的手机进行 逐一适配。
API
描述
设置苹果系统离线推送专用监听器
设置离线推送配置信息
设置离线推送配置信息
设置离线推送配置信息

好友管理相关接口

腾讯云 IM 在收发消息时默认不检查是不是好友关系，您可以在 控制台 > 功能配置 > 登录与消息 > 好友关系检查中开启"发送单聊消息检查关系链"开关，并使用如下接口增删好友和管理好友列表。
API
描述
设置关系链的监听器，用于接收好友列表和黑名单的变更事件
添加关系链监听器
移除关系链监听器
获取好友列表
获取指定好友资料
设置指定好友资料
添加好友
删除好友
检查指定用户的好友关系
获取好友申请列表
同意好友申请
拒绝好友申请
删除好友申请
设置好友申请已读
新建好友分组
获取分组信息
删除好友分组
修改好友分组的名称
添加好友到一个好友分组
从好友分组中删除好友
搜索好友

中国站
文档反馈
文档活动
message-icon联系我们
目录