Call
  • Web
    • Overview
      • Product Introduction
      • Activate the Service
      • 价格中心
        • 免费时长
        • Call 包月套餐
        • 订阅套餐时长计费说明
    • Get Started
      • Run Sample Code
      • Integration (React)
      • Integration (Vue3)
      • Secure authentication with userSig
    • Basic Features
      • UI Customization
      • Configuring Nickname and Avatar
      • GroupCall
      • 悬浮窗
      • 自定义铃声
      • 设置分辨率和填充模式
      • 监控通话状态
    • Advanced Features
      • 虚拟背景
      • AI 降噪
      • 云端录制
    • 客户端 API
      • UIKit APIs
        • API Overview
        • TUICallKit
      • Engine APIs
        • TUICallEngine
        • TUICallEvent
    • 服务端 API
      • 通话状态回调
        • 通话状态回调
        • 通话事件回调
        • 回调配置
          • 回调配置接口列表
          • 创建回调配置
          • 查询回调配置
          • 更新回调配置
          • 删除回调配置
      • REST 接口
        • REST 接口简介
        • 通过 callId 获取记录
        • 通过条件获取记录
    • FAQs
      • All Platfroms
      • Web
      • ErrorCode
      • 发布说明
  • Android
    • Overview
      • Product Introduction
      • Activate the Service
      • Pricing
        • Free Minutes
        • Call Monthly Packages
        • Billing Explanation for Subscription Package Duration
    • Get Started
      • 跑通 Demo
      • 集成
      • Secure authentication with userSig
    • Basic Features
      • UI 定制
      • 离线通话推送
      • Configuring Nicknames and Avatars
      • 群组通话
      • 悬浮窗
      • 自定义铃声
      • 监控通话状态
    • 更多功能
      • 虚拟背景
      • AI 降噪
      • 云端录制
    • 客户端 API
      • UIKit APIs
        • 接口概述
        • TUICallKit
        • TUICallObserver
        • 类型定义
      • Engine APIs
        • TUICallEngine
    • 服务端 API
      • 通话状态回调
        • 通话状态回调
        • 通话事件回调
        • 回调配置
          • 回调配置接口列表
          • 创建回调配置
          • 查询回调配置
          • 更新回调配置
          • 删除回调配置
      • REST 接口
        • REST 接口简介
        • 通过 callId 获取记录
        • 通过条件获取记录
    • FAQs
      • All Platforms
      • Android
      • ErrorCode
      • 发布说明
  • iOS
    • Overview
      • Product Introduction
      • Activate the Service
      • Pricing
        • Free Minutes
        • Call Monthly Packages
        • Billing Explanation for Subscription Package Duration
    • Get Started
      • 跑通 Demo
      • 集成
      • Secure authentication with userSig
    • Basic Features
      • UI 定制
      • 离线通话推送
        • VoIP
        • APN
      • 设置昵称和头像
      • 群组通话
      • 悬浮窗
      • 自定义铃声
      • 监控通话状态
    • 更多功能
      • 虚拟背景
      • AI 降噪
      • 云端录制
    • 客户端 API
      • UIKit APIs
        • 接口概述
        • TUICallKit
        • TUICallObserver
        • 类型定义
      • Engine APIs
        • TUICallEngine
    • 服务端 API
      • 通话状态回调
        • 通话状态回调
        • 通话事件回调
        • 回调配置
          • 回调配置接口列表
          • 创建回调配置
          • 查询回调配置
          • 更新回调配置
          • 删除回调配置
      • REST 接口
        • REST 接口简介
        • 通过 callId 获取记录
        • 通过条件获取记录
    • FQAs
      • All Platform
      • iOS
      • ErrorCode
      • 发布说明
  • Flutter
    • Overview
      • 产品概述
      • 开通服务
      • Pricing
        • Free Minutes
        • Call Monthly Packages
        • Billing Explanation for Subscription Package Duration
    • Get Started
      • 跑通 Demo
      • 集成
      • Secure authentication with userSig
    • Basic Features
      • UI 定制
      • 离线通话推送
        • 通知
        • VoIP(可选)
      • 设置昵称和头像
      • 群组通话
      • 悬浮窗
      • 自定义铃声
      • 监控通话状态
    • 更多功能
      • 虚拟背景
      • AI 降噪
      • 云端录制
      • 美颜特效
    • 客户端 API
      • 接口概述
      • TUICallKit
      • TUICallEngine
      • TUICallObserver
      • 类型定义
    • 服务端 API
      • 通话状态回调
        • 通话状态回调
        • 通话事件回调
        • 回调配置
          • 回调配置接口列表
          • 创建回调配置
          • 查询回调配置
          • 更新回调配置
          • 删除回调配置
      • REST 接口
        • REST 接口简介
        • 通过 callId 获取记录
        • 通过条件获取记录
    • FQAs
      • All Platform
      • Flutter
      • ErrorCode
      • 升级
      • 发布说明
Call

TUICallKit

TUICallKit API 简介

TUICallKit API 是音视频通话组件的含 UI 接口,使用 TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景,更详细的接入步骤,详情请参见 快速接入TUICallKit

API 概览

API
描述
创建 TUICallKit 实例(单例模式)
设置用户的昵称、头像
call
发起 1v1 通话
call
发起 1v1 通话,支持自定义房间号、通话邀请超时时间,离线推送内容等
groupCall
发起群组通话
groupCall
发起群组通话,支持自定义房间号、通话邀请超时时间,离线推送内容等
主动加入当前的群组通话中
设置自定义来电铃音
开启/关闭静音模式
开启/关闭悬浮窗功能
开启/关闭来电横幅显示

API 详情

createInstance

创建 TUICallKit 的单例。
Kotlin
Java
fun createInstance(context: Context): TUICallKit
TUICallKit createInstance(Context context)

setSelfInfo

设置用户昵称、头像。用户昵称不能超过500字节,用户头像必须是 URL 格式。
Kotlin
Java
fun setSelfInfo(nickname: String?, avatar: String?, callback: TUICommonDefine.Callback?)
void setSelfInfo(String nickname, String avatar, TUICommonDefine.Callback callback)
参数如下表所示:
参数
类型
含义
nickname
String
目标用户的昵称
avatar
String
目标用户的头像

call

拨打电话(1v1通话)。
Kotlin
Java
fun call(userId: String, callMediaType: TUICallDefine.MediaType)
void call(String userId, TUICallDefine.MediaType callMediaType)
参数如下表所示:
参数
类型
含义
userId
String
目标用户的 userId
callMediaType
通话的媒体类型,比如视频通话、语音通话

call

拨打电话(1v1通话),支持自定义房间号、通话邀请超时时间,离线推送内容等。
Kotlin
Java
fun call(
userId: String, callMediaType: TUICallDefine.MediaType,
params: CallParams?, callback: TUICommonDefine.Callback?
)
void call(String userId, TUICallDefine.MediaType callMediaType,
TUICallDefine.CallParams params, TUICommonDefine.Callback callback)
参数如下表所示:
参数
类型
含义
userId
String
目标用户的 userId
callMediaType
通话的媒体类型,比如视频通话、语音通话
params
通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等

groupCall

发起群组通话。
注意
使用群组通话前需要创建IM 群组,如果已经创建,请忽略。
群组的创建详见: IM 群组管理 ,或者您也可以直接使用 IM TUIKit,一站式集成聊天、通话等场景。
Kotlin
Java
fun groupCall(groupId: String, userIdList: List<String?>?, callMediaType: TUICallDefine.MediaType)
void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType);
参数如下表所示:
参数
类型
含义
groupId
String
此次群组通话的群 ID
userIdList
List
目标用户的 userId 列表
callMediaType
通话的媒体类型,比如视频通话、语音通话

groupCall

发起群组通话,支持自定义房间号、通话邀请超时时间,离线推送内容等。
注意
使用群组通话前需要创建IM 群组,如果已经创建,请忽略。
群组的创建详见: IM 群组管理 ,或者您也可以直接使用 IM TUIKit,一站式集成聊天、通话等场景。
Kotlin
Java
fun groupCall(
groupId: String, userIdList: List<String?>?,
callMediaType: TUICallDefine.MediaType, params: CallParams?,
callback: TUICommonDefine.Callback?
)
void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType,
TUICallDefine.CallParams params, TUICommonDefine.Callback callback);
参数如下表所示:
参数
类型
含义
groupId
String
此次群组通话的群 ID
userIdList
List
目标用户的 userId 列表
callMediaType
通话的媒体类型,比如视频通话、语音通话
params
通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等

joinInGroupCall

加入群组中已有的音视频通话。
注意
加入群组中已有的音视频通话前,需要提前创建或加入IM 群组,并且群组中已有用户在通话中,如果已经创建,请忽略。
群组的创建详见: IM 群组管理 ,或者您也可以直接使用 IM TUIKit,一站式集成聊天、通话等场景。
Kotlin
Java
fun joinInGroupCall(roomId: RoomId?, groupId: String?, callMediaType: TUICallDefine.MediaType?)
void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefine.MediaType callMediaType);
参数如下表所示:
参数
类型
含义
roomId
此次通话的音视频房间 ID
groupId
String
此次群组通话的群 ID
callMediaType
通话的媒体类型,比如视频通话、语音通话

setCallingBell

设置自定义来电铃音。 这里仅限传入本地文件地址,需要确保该文件目录是应用可以访问的。
铃声设置后与设备绑定,更换用户,铃声依旧会生效。
如需恢复默认铃声,filePath 传空即可。
Kotlin
Java
fun setCallingBell(filePath: String?)
void setCallingBell(String filePath);

enableMuteMode

开启后,收到通话请求,不会播放来电铃声。
Kotlin
Java
fun enableMuteMode(enable: Boolean)
void enableMuteMode(boolean enable);

enableFloatWindow

开启/关闭悬浮窗功能。
默认为false,通话界面左上角的悬浮窗按钮隐藏,设置为 true 后显示。
Kotlin
Java
fun enableFloatWindow(enable: Boolean)
void enableFloatWindow(boolean enable);

enableIncomingBanner

开启/关闭来电横幅显示。
默认为false,被叫端收到邀请后默认弹出全屏通话等待界面,开启后先展示一个横幅,然后根据需要拉起全屏通话界面。
fun enableIncomingBanner(enable: Boolean)