SDK 文档

服务端 API

功能介绍

最近更新时间:2021-09-07 18:37:05

平台支持

以下平台都支持互通,且能跨终端全平台服务。

平台 SDK 及兼容性 Demo 源码 UI 组件
Android 兼容支持 JDK 1.6 和 Android SDK version 14 以上系统 支持 支持 支持
iOS 兼容 iOS 8.0 以上版本 支持 支持 支持
Mac 兼容 OS X 10.10 以上版本 支持 支持 -
Windows 包含C 、C++ ,兼容 Windows 7、Windows 8/8.1、Windows 10;全面支持32位和64位程序接入 - - -
Web 支持 IE 11+,Chrome 7+,FireFox 3.6+,Opera 12+ 和 Safari 6+ 支持 - -
小程序 支持 支持 - -
Unity 支持 2020.2.7f1c1 及以上版本 支持 支持 -
Flutter 支持 Flutter 2.0.12 版本 支持 支持 -

全球接入

功能类型 功能描述
全球接入简介 即时通信 IM 提供覆盖全球的高连通、高可靠、强安全的网络连接通道,自研多重最优寻址算法,具有全网调度能力,终端在海外登录时,IM SDK 会访问就近接入点或加速点
中国 华南、华北、华东、香港、台湾等
海外 亚洲:日本、韩国、新加坡、印度、泰国、马来西亚、越南、菲律宾、阿联酋、印度尼西亚
欧洲:德国、英国、法国、俄罗斯、意大利、挪威、西班牙、荷兰
北美洲:美国、加拿大、墨西哥
南美洲:巴西
大洋洲:澳大利亚
非洲:南非、尼日利亚等

帐号功能

功能类型 功能描述
帐号导入 批量导入帐号
帐号禁用 UserSig 失效
帐号删除 批量删除帐号
用户在线状态 管理在线和离线状态(以用户登录为前提)
查询账号 批量查询账号是否导入

多端登录

功能类型 功能描述
同平台登录 Android、iPhone、iPad、Windows、Mac、Web仅可有1种平台在线
双平台登录(默认) Android、iPhone、iPad、Windows、Mac可有1端在线;Web可同时在线
三平台登录 Android、iPhone、iPad可有1种平台在线;Windows、Mac可有1种平台在线;Web可同时在线
多平台登录 Android、iPhone、iPad、Windows、Mac、Web可全平台同时在线
说明:

您可以登录 即时通信 IM 控制台,单击目标应用所在行的应用配置,在功能配置页配置多端登录。

消息类型

功能类型 功能描述
文本消息 消息内容是普通文本
图片消息 消息内容为图片 URL 地址、尺寸、图片大小等信息
表情消息 表情消息为开发者自定义
语音消息 语音数据需要提供时长信息,以秒为单位
地理位置消息 消息内容为地理位置标题、经度、纬度信息
文件消息 消息内容为文件的 URL 地址、大小、格式等信息,格式不限,最大支持100M
短视频消息 消息内容为视频文件的 URL 地址、时长、大小、格式等信息,最大支持100M
自定义消息 开发者自定义的消息类型,例如红包消息、石头剪刀布等形式的消息
系统通知消息 包含内置的系统通知消息和开发者自定义系统通知消息
群 Tips 消息 系统性通知消息,例如有成员进出群组,群的描述信息被修改,群成员的资料发生变化等
合并消息 最大支持300条消息合并

消息功能

功能类型 功能描述
消息下载 App 管理员可以通过该接口获取 App 中最近7天某天某小时的所有单发或群组消息记录
离线消息 用户登录后退到后台,当有用户给其发消息时,即时通信 IM 支持离线推送
漫游消息 在新设备登录时,将服务器记录(云端)的历史消息存储进行同步,默认保存7天,可付费延长
多端同步 多终端消息同步,可同时收到消息
历史消息 支持本地历史消息和云端历史消息
消息撤回 撤回投递成功的消息,默认撤回 2 分钟内的消息。撤回操作仅支持单聊和群聊消息,不支持直播群(AVChatRoom)的撤回
已读回执 查看点对点会话中对方的已读未读状态
消息转发 将消息转发给其他用户或群组
@功能 群内 @ 消息与普通消息没有本质区别,仅是在被 @ 的人在收到消息时,需要在 UI 上做特殊处理
正在输入 可以通过在线消息实现
离线推送 支持苹果 APNs、小米推送、华为推送、魅族推送、OPPO 推送、vivo 推送、Google FCM 推送
消息删除 使用消息的 remove 方法可以在本地删除消息
红包功能 红包消息与@消息类似,可以通过 TIMCustomElem 来实现
全员推送 基于即时通信 IM 通信架构实现的一组 REST API,用以支持 App 应用的全员推送、标签推送、属性推送等消息推送需求,客户端可通过 SDK 在线推送、离线推送(Android 后台通知和 APNs)接收推送的消息
本地消息搜索 支持搜索好友,搜索群组、群成员;搜索消息,按照会话分组

资料功能

功能类型 功能描述
设置用户资料 用户设置自己的昵称、验证方式、头像、性别、年龄、签名、位置等资料
获取用户资料 用户查看自己、好友及陌生人资料
按字段获取用户资料 按照特定字段获取用户资料
自定义用户资料 最大20个自定义用户资料字段

关系链功能

功能类型 功能描述
查找好友 可通过用户帐号 ID 查找好友
申请添加好友 要选择默认是否需要申请理由,目前是默认不需要
添加好友 发送添加好友请求
导入好友 支持批量导入单向好友
更新好友 支持批量更新同一用户的多个好友的关系链数据
删除好友 成为好友后可以删除好友
获取所有好友 获取所有好友,默认只拉取基本资料
同意/拒绝好友 收到请求加好友请求的系统通知后,可以通过或者拒绝
添加用户到黑名单 把任意用户拉黑,如果此前是好友关系会解除好友关系
移除黑名单 把用户从黑名单中移除
获取黑名单列表 拉取用户黑名单列表
好友备注 成为好友后可以给好友备注
设置好友自定义资料 最多20个好友自定义字段
创建好友分组 创建分组时,可以同时指定添加的用户,同一用户可以添加到多个分组
删除好友分组 删除好友分组
校验好友 支持批量校验好友关系
校验黑名单 支持批量校验黑名单
添加好友到某分组 将好友添加到好友分组
从某分组删除好友 将好友从好友分组中删除
重命名好友分组 重命名好友分组
获取指定好友分组信息 获取指定的好友分组
获取所有好友分组 获取所有分组信息,另外,通过获取所有好友也可以获取分组信息
关系链资料存储 SDK 可以对关系链资料进行存储
好友资料变更系统通知 好友资料变更可以收到系统通知
关系链变更系统通知 关系链变更可以收到系统通知

群组功能

即时通信 IM 根据常见使用场景,默认配置了以下群组类型:

  • 好友工作群(Work):类似普通微信群,创建后仅支持已在群内的好友邀请加群,且无需被邀请方同意或群主审批;
  • 陌生人社交群(Public):类似 QQ 群,创建后群主可以指定群管理员,用户搜索群 ID 发起加群申请后,需要群主或管理员审批通过才能入群;
  • 临时会议群(Meeting):创建后可以随意进出,且支持查看入群前消息;适合用于音视频会议场景、在线教育场景等与实时音视频产品结合的场景;
  • 直播群(AVChatRoom):创建后可以随意进出,没有群成员数量上限,但不支持历史消息存储;适合与直播产品结合,用于弹幕聊天场景。

每个群组类型的默认功能差异如下表示意:

功能类型 好友工作群(Work) 陌生人社交群(Public) 临时会议群(Meeting) 直播群(AVChatRoom)
成员上限
  • 体验版:20人/群

  • 专业版:默认为200人/群,最高支持 增值 扩展至2000人/群

  • 旗舰版:默认为2000人/群,最高支持 增值 扩展至6000人/群
  • 体验版:20人/群

  • 专业版:默认为200人/群,最高支持 增值 扩展至2000人/群

  • 旗舰版:默认为2000人/群,最高支持 增值 扩展至6000人/群
  • 体验版:20人/群

  • 专业版:默认为200人/群,最高支持 增值 扩展至2000人/群

  • 旗舰版:默认为2000人/群,最高支持 增值 扩展至6000人/群
  • 无上限
    群资料修改 群成员
  • 群管理员

  • 群主

  • App 管理员
  • 群主

  • App 管理员
  • App 管理员
    成员列表 全部可见 全部可见 全部可见 展示 300 人
    解散群组 App 管理员
  • 群主

  • App 管理员
  • 群主

  • App 管理员
  • 群主

  • App 管理员
  • 申请加群 不支持 允许 允许 允许
    加群审批 不支持 需审批 无审批 无审批
    邀请加群 被邀请人无需审批 不支持 不支持 不支持
    群主退群 支持 不支持 不支持 不支持
    设置管理员 不支持 支持 支持 不支持
    移出成员
  • 群主

  • App 管理员
  • 群管理员

  • 群主

  • App 管理员
  • 群管理员

  • 群主

  • App 管理员
  • 不支持
    是否支持查看入群前历史消息 不支持 不支持 支持 不支持
    成员变更通知 全员 全员 全员
    群组激活 消息激活 不需要 不需要 不需要
    成员禁言 不支持 支持 支持 支持
    未读计数 支持 支持 支持 不支持
    游客身份接收消息 不支持 不支持 不支持 支持
    历史消息存储 支持 支持 支持 不支持
    默认消息接收选项 接收在线推送消息和离线推送 接收在线推送消息和离线推送 只接收在线推送消息 只接收在线推送消息
    导入群 支持 支持 支持 不支持

    即时通信 IM 控制台

    您可以在腾讯云 即时通信 IM 控制台 根据您的需求对您的应用进行配置。

    功能类型 功能描述
    创建应用 新建应用
    升级应用 套餐包版本升级
    下载 SDK 下载客户端的 SDK
    应用配置 可进行应用配置
    统计分析 运营数据查看
    回调配置 第三方回调
    功能配置 增加自定义字段和在线实例
    群组管理 添加、修改、解散群组、管理群成员、发送消息
    开发者辅助工具 在网页端生成 UserSig
    安全打击 对不雅消息进行识别、打击

    数据统计

    即时通信 IM 控制台的 统计分析 功能有各类维度的数据统计,为您提供运营数据。

    统计类型 功能描述
    活跃用户数 与服务器产生连接交互的去重用户数
    新增注册用户数 新增注册 ID 数量
    累计注册用户数 查看所有注册用户数
    上行消息数 可以选择时间查看上行消息数
    发送消息人数 可以选择时间查看发送消息人数
    最高同时在线人数 可以选择时间查看在线同时在线人数
    单聊上行消息数 可以选择时间查看单聊上行消息数
    单聊发消息人数 可以选择时间查看单聊发消息人数
    群聊上行消息数 可以选择时间查看群组中上行消息数
    群聊发消息人数 可以选择时间查看群组中发消息的人数
    发消息群组数 可以选择时间查看发消息群组数
    新增群组数 可以选择时间查看新增群组数
    累计群组数 可以选择时间查看累计群组数
    导出数据 可以选择时间导出数据

    实时监控

    即时通信 IM 控制台的 统计分析 功能有各类维度的数据统计,为您提供运营数据。

    统计类型 功能描述
    当前在线用户数 实时在线人数
    今日单聊消息量 当天单聊消息总量
    今日普通群消息量 当天非直播群消息总量
    今日直播群消息量 当天直播群消息总量

    私有化支持

    私有化部署允许企业将系统直接部署到企业自己的服务器上,数据直接保存在本地。即时通信 IM 已支持私有化部署功能,可以协助企业进行私有化版本的部署、实施、运营维护。如您有使用需求请申请 即时通信 IM 私有化服务

    说明:

    申请时需要您登录腾讯云主账号。

    目录