常规集成(无 UI 库)

服务端 API

功能介绍

最近更新时间:2020-09-01 19:39:14

平台支持

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

平台 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 9+,Chrome 7+,FireFox 3.6+,Opera 12+ 和 Safari 6+ 支持 - -
小程序 支持 支持 - -

全球接入

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

帐号功能

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

多端登录

功能类型 功能描述
单端登录 仅允许 Windows、Web、Android 或 iOS 单端登录
双端登录(默认状态) 允许 Windows、Android 或 iOS 单端登录,同时允许与 Web 端同时在线
三端登录 允许 Android 或 iOS 单端登录,同时允许与 Windows 和 Web 端同时在线
多端同时在线 允许 Windows、Web、Android 或 iOS 多端或全端同时在线登录
说明:

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

消息类型

功能类型 功能描述
文本消息 消息内容是普通文本
图片消息 消息内容为图片 URL 地址、尺寸、图片大小等信息
表情消息 表情消息为开发者自定义
语音消息 语音数据需要提供时长信息,以秒为单位
地理位置消息 消息内容为地理位置标题、经度、纬度信息
文件消息 消息内容为文件的 URL 地址、大小、格式等信息,格式不限,最大支持28M
短视频消息 消息内容为视频文件的 URL 地址、时长、大小、格式等信息,最大支持28M
自定义消息 开发者自定义的消息类型,例如红包消息、石头剪刀布等形式的消息
系统通知消息 包含内置的系统通知消息和开发者自定义系统通知消息

消息功能

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

资料功能

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

关系链功能

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

群组功能

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

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

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

功能类型
好友工作群
(Work)
陌生人交友群
(Public)
临时会议群
(Meeting)
直播群
(AVChatRoom)
最高支持成员数量上限 6000人 6000人 6000人 无上限
可获取成员资料限制 全部可见 全部可见 全部可见 仅展示前300个加群的成员
是否支持设置管理员 不支持 支持 支持 不支持
群资料修改权限
  • 任意群成员均可修改
  • 后台 App 管理员
  • 群主
  • 群管理员
  • 后台 App 管理员
  • 群主
  • 群管理员
  • 后台 App 管理员
  • 群主
  • 后台 App 管理员
  • 解散群组权限 后台 App 管理员
  • 群主
  • 后台 App 管理员
  • 群主
  • 后台 App 管理员
  • 群主
  • 后台 App 管理员
  • 是否支持群主退群 支持 不支持 不支持 不支持
    是否支持申请加群 不支持 支持,但需要群主或管理员审批 支持,且无需审批 支持,且无需审批
    是否支持成员邀请他人加群 支持 不支持 不支持 不支持
    “踢人”权限
  • 群主
  • 后台 App 管理员
  • 群主
  • 群管理员
  • 后台 App 管理员
  • 群主
  • 群管理员
  • 后台 App 管理员
  • 不支持踢人,可用“禁言”功能达到类似效果
    “禁言”权限 不支持禁言
  • 群主
  • 群管理员(仅支持禁言普通群成员)
  • 后台 App 管理员
  • 群主
  • 群管理员(仅支持禁言普通群成员)
  • 后台 App 管理员
  • 群主
  • 后台 App 管理员
  • 是否支持查看入群前历史消息 不支持 不支持 支持 不支持
    成员变更通知(进群/退群等) 全员 全员 全员
    是否需要在创建群组后发消息激活 需要 不需要 不需要 不需要
    是否支持未读消息计数 支持 支持 不支持 不支持
    是否支持导入群(群成员/基础资料等) 支持 支持 支持 不支持

    即时通信 IM 控制台

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

    功能类型 功能描述
    创建应用 新建应用
    下载 SDK 下载客户端的 SDK
    应用配置 可进行应用配置
    统计分析 运营数据查看
    查看 Crash 错误上报
    回调配置 第三方回调
    功能配置 增加自定义字段和在线实例
    开发者辅助工具 在网页端生成 UserSig

    数据统计

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

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