• UIKit
  • SDK
  • 服务端 API
Chat/
SDK/
Windows/
客户端 API/
SDK
  • 集成 SDK
  • 初始化
  • 登录登出
  • 消息
    • 介绍
    • 发送消息
    • 接收消息
    • 历史消息
    • 转发消息
    • 消息变更
    • 插入消息
    • 删除消息
    • 清空消息
    • 撤回消息
    • 在线消息
    • 已读回执
    • 查询消息
    • 群 @ 消息
    • 群定向消息
    • 消息免打套
    • 消息扩展
    • 消息回应
    • 消息翻译
    • 消息置顶
  • 会话
    • 介绍
    • 会话列表
    • 获取会话
    • 会话未读数
    • 置顶会话
    • 删除会话
    • 会话草稿
    • 会话标记
    • 会话分组
  • 群组
    • 介绍
    • 管理群组
    • 群资料
    • 管理群成员
    • 群成员资料
    • 自定义属性
    • 群计数器
  • 社群话题
    • 管理社群
    • 权限组
  • 用户
    • 用户资料
    • 用户状态
    • 管理好友
    • 好友分组
    • 黑名单
    • 关注与粉丝
  • 本地搜索
    • 搜索消息
    • 搜索好友
    • 搜索群组
    • 搜索群成员
  • 信令
  • 客户端 API
    • C++
    • C
  • 更新日志
  • 开发指引
  • 控制台指南
    • 创建和升级应用
    • 基本配置
    • 功能配置
    • 账号管理
    • 群组管理
    • 回调配置
  • 产品介绍
    • 消息管理
      • 单聊消息
      • 消息存储
      • 离线推送
      • 群消息
      • 消息格式
    • 账号系统
      • 登陆验证
      • 在线状态管理
    • 群相关
      • 群组系统
      • 群组管理
    • 用户资料和关系链
      • 资料管理
      • 关系链管理
  • 购买指南
    • 计费概述
    • 价格中心
  • 错误码

C

IM SDK 初始化相关接口

初始化并成功登录,是正常使用腾讯云 IM 服务的前提。
API
描述
TIMInit
IM SDK 初始化
TIMUninit
IM SDK 卸载
获取 IM SDK 版本号
获取服务器当前时间
设置额外的用户配置

登录登出相关接口

API
描述
TIMLogin
登录
TIMLogout
登出
获取登录用户的 userID
获取登录状态

消息相关接口

API
描述
发送新消息
根据消息 messageID 取消发送中的消息
群发消息,该接口不支持向群组发送消息。
下载消息内元素到指定文件路径(图片、视频、音频、文件)
下载合并消息
设置消息自定义数据(本地保存,不会发送到对端,程序卸载重装后失效)
设置针对某个用户的 C2C 消息接收选项(支持批量设置)
查询针对某个用户的 C2C 消息接收选项
设置群消息的接收选项
设置登录用户全局消息接收选项(支持设置每天的免打扰时间)
设置登录用户全局消息接收选项
获取登录用户全局消息接收选项
获取指定会话的消息列表
消息撤回
消息修改
删除指定会话的消息
删除指定会话的本地及漫游消息列表
清空指定会话的消息
保存自定义消息
导入消息列表到指定会话
根据消息 messageID 查询本地的消息列表
根据消息定位精准查找指定会话的消息
搜索本地消息
搜索云端消息
发送消息已读回执
获取消息已读回执
获取群消息已读群成员列表
设置消息扩展
获取消息扩展
删除消息扩展
添加消息回应
删除消息回应
批量拉取多条消息回应信息
分页拉取使用指定消息回应用户信息
翻译文本消息
设置群消息置顶
获取已置顶的群消息列表

会话相关接口

会话列表,即登录后首屏看到的列表,包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
API
描述
获取会话列表
查询一组会话列表
获取会话列表高级接口
删除会话
删除会话列表
设置指定会话的草稿
删除指定会话的草稿
设置会话自定义数据
设置会话置顶
标记会话
获取所有会话总的未读消息数
根据 filter 获取未读总数
注册监听指定 filter 的会话未读总数变化
取消监听指定 filter 的会话未读总数变化
清理会话的未读消息计数
创建会话分组
获取会话分组列表
删除会话分组
重命名会话分组
添加会话到一个会话分组
从会话分组中删除多个会话

群组相关接口

腾讯云 IM SDK 支持以下预设的群组类型,每种类型都有其适用场景:
工作群(Work):类似普通微信群,创建后不能自由加入,必须由已经在群的用户邀请入群。
公开群(Public):类似 QQ 群,用户申请加入,但需要群主或管理员审批。
会议群(Meeting):适合跟 TRTC 结合实现视频会议和在线教育等场景,支持随意进出,支持查看进群前的历史消息。
社群(Community):社群成员上限 100000 人,任何人都可以自由进出,且加群无需被审批,适合用于知识分享和游戏交流等超大社区群聊场景。5.8 版本开始支持,需 购买进阶版 并在 控制台 >功能配置 > 群组配置 > 群功能配置 > 社群 中开通。
直播群(AVChatRoom):适合直播弹幕聊天室等场景,支持随意进出,人数无上限。
API
描述
创建群组
删除(解散)群组
申请加入群组
退出群组
获取已加入群组列表
获取群组信息列表
搜索群列表
修改群信息
初始化群属性,会清空原有的群属性列表
设置群属性,已有该群属性则更新其 value 值,没有该群属性则添加该群属性
删除群属性
获取群指定属性,若传入的 json_keys 为空,则获取所有群属性
获取指定群在线人数
设置群计数器
获取群计数器
递增群计数器
递减群计数器
获取当前用户已经加入的支持话题的社群列表
创建话题
删除话题
修改话题信息
获取话题列表
获取群成员信息列表
搜索群成员
修改群成员信息
邀请加入群组
删除群组成员
标记群成员
获取群未决信息列表。
群未决信息是指还没有处理的操作,例如,邀请加群或者请求加群操作还没有被处理,称之为群未决信息
处理群未决信息
上报群未决信息已读

社群话题相关接口

API
描述
创建支持话题的社群
获取当前用户已经加入的支持话题的社群列表
创建话题
删除话题
修改话题信息
获取话题列表
创建权限组
删除权限组
修改权限组信息
获取已加入的权限组列表
获取权限组列表
向社群权限组添加成员
从社群权限组删除成员
获取社群权限组成员列表
向权限组添加话题权限
从权限组中删除话题权限
修改权限组中的话题权限
获取权限组中的话题权限

用户资料相关接口

API
描述
获取指定用户列表的个人资料
修改自己的个人资料
订阅陌生人资料
取消订阅陌生人资料

用户状态相关接口

API
描述
获取指定用户列表的状态
设置自己的状态
订阅用户状态
取消订阅用户状态

好友相关接口

腾讯云 IM 在收发消息时默认不检查是不是好友关系,您可以在 控制台 >功能配置>登录与消息>好友关系检查中开启"发送单聊消息检查关系链"开关,并使用如下接口增删好友和管理好友列表。
API
描述
获取好友列表
获取好友信息
更新好友资料(备注等)
搜索好友
添加好友
删除好友
检测好友类型(单向或双向)
获取好友添加请求未决信息列表
处理好友请求
上报好友添加请求未决信息已读
删除指定好友添加请求未决信息
获取黑名单列表
添加指定用户到黑名单
从黑名单中删除指定用户列表
创建好友分组
获取指定好友分组的分组信息
删除好友分组
修改好友分组

公众号相关接口

公众号可以为订阅的用户发送广播消息,也可以与订阅的用户进行单聊。
API
描述
订阅公众号
取消订阅公众号
获取公众号列表

关注和粉丝相关接口

关注和粉丝功能可以帮助建立和维护用户之间相对简单的连接关系,方便促进用户之间的互动和交流。
API
描述
关注用户
取消关注用户
获取我的关注列表
获取我的粉丝列表
获取我的互关列表
获取指定用户的 关注/粉丝/互关 数量信息
检查指定用户的关注类型

离线推送相关接口

API
描述
设置离线推送配置信息(iOS 和 Android 平台专用)
APP 检测到应用退后台时可以调用此接口,可以用作桌面应用角标的初始化未读数量(iOS 和 Android 平台专用)
APP 检测到应用进前台时可以调用此接口(iOS 和 Android 平台专用)

信令相关接口

API
描述
邀请某个人
邀请群内的某些人
邀请方取消邀请
被邀请方接受邀请
被邀请方拒绝邀请
获取信令信息
修改邀请信令

事件回调设置接口

初始化以及登录相关回调设置接口

API
描述
设置网络状态回调
设置被踢下线回调
设置用户票据过期回调
设置日志回调

消息相关回调设置接口

API
描述
增加接收新消息回调
删除接收新消息回调
设置消息内元素相关文件上传进度回调
设置消息已读回执回调
设置接收的消息被撤回回调
设置消息在云端被修改后回传回来的消息更新通知回调
设置消息扩展信息更新的回调
设置消息扩展信息删除的回调
设置消息回应信息更新的回调
设置全局消息接收选项的回调

会话相关回调设置接口

API
描述
设置会话事件回调
设置会话未读消息总数变更的回调
设置按会话 filter 过滤的未读消息总数变更的回调
设置会话分组被创建回调
设置会话分组被删除的回调
设置会话分组命名变更回调
设置会话分组新增会话的回调
设置会话分组删除会话的回调

群组相关回调设置接口

API
描述
设置群组系统消息回调
设置群组属性变更回调
设置群计数器变更回调
设置话题被创建的回调
设置话题被删除的回调
设置话题更新的回调

社群话题相关回调设置接口

API
描述
设置话题被创建的回调
设置话题被删除的回调
设置话题更新的回调
设置 RESTAPI 下发的话题自定义系统消息的回调
设置权限组被创建的回调
设置权限组被删除的回调
设置权限组更新的回调
设置向权限组中添加成员的回调
设置从权限组中删除成员的回调
设置向权限组中增加话题权限的回调
设置从权限组删除话题权限的回调
设置权限组中的话题权限修改的回调

用户资料以及状态相关回调设置接口

API
描述
设置当前用户资料更新回调
设置用户状态变更回调
设置已订阅用户资料变更回调

好友相关回调设置接口

API
描述
设置添加好友的回调
设置删除好友的回调
设置更新好友资料的回调
设置好友添加请求的回调
设置好友申请被删除的回调
设置好友申请已读的回调
设置黑名单新增的回调
设置黑名单删除的回调
设置好友分组被创建的回调
设置好友分组被删除的回调
设置好友分组名变更的回调
设置好友分组新增好友的回调
设置好友分组删除好友的回调

公众号相关回调设置接口

API
描述
设置公众号订阅的回调
设置公众号取消订阅的回调
设置订阅的公众号被删除的回调
设置订阅的公众号资料更新的回调

关注和粉丝相关回调设置接口

API
描述
设置关注列表变更的回调
设置粉丝列表变更的回调
设置互关列表变更的回调

信令相关回调设置接口

API
描述
设置收到信令邀请的回调
设置信令邀请被取消的回调
设置信令邀请被接收者同意的回调
设置信令邀请被接收者拒绝的回调
设置信令邀请超时的回调
设置信令邀请被修改的回调