tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
产品简介
产品概述
基本概念
产品功能
产品优势
应用场景
性能数据
购买指南
计费概述
免费时长说明
月订阅
现收现付
TRTC 逾期与暂停政策
常见问题解答
退款说明
新手指引
Demo 体验
视频通话 SDK
组件介绍
开通服务
跑通 Demo
快速接入
离线唤醒
会话聊天
云端录制
AI 降噪
界面定制
Chat 集成通话能力
更多特性
无 UI 集成
服务端 API
客户端 API
解决方案
错误码表
发布日志
常见问题
视频会议 SDK
组件介绍（TUIRoomKit）
开通服务（TUIRoomKit）
跑通 Demo（TUIRoomKit）
快速接入（TUIRoomKit）
屏幕共享（TUIRoomKit）
预定会议（TUIRoomKit）
会中呼叫（TUIRoomKit）
界面定制（TUIRoomKit）
虚拟背景（TUIRoomKit）
会议控制（TUIRoomKit）
云端录制（TUIRoomKit）
AI 降噪（TUIRoomKit）
会中聊天（TUIRoomKit）
机器人推流（TUIRoomKit）
更多特性（TUIRoomKit）
客户端 API（TUIRoomKit）
服务端 API（TUIRoomKit）
常见问题（TUIRoomKit）
错误码 (TUIRoomKit)
SDK更新日志（TUIRoomKit）
直播与语聊 SDK
Live 视频直播计费说明
组件介绍
开通服务（TUILiveKit）
跑通 Demo
无 UI 集成
UI 自定义
直播监播
视频直播
语聊房
高级功能
客户端 API
服务端 API
错误码
发布日志
常见问题
RTC Engine
开通服务
SDK 下载
API-Example
接入指引
API-参考手册
高级功能
AI 集成
概述
MCP 配置
Skills 配置
集成指南
常见问题
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
控制台指南
应用管理
套餐包管理
用量统计
监控仪表盘
开发辅助
解决方案
实时合唱
常见问题
迁移指南
计费相关
功能相关
UserSig 相关
应对防火墙限制相关
缩减安装包体积相关
Andriod 与 iOS 相关
Web 端相关
Flutter 相关
Electron 相关
TRTCCalling Web 相关
音视频质量相关
其他问题
旧版文档
RTC RoomEngine SDK（旧）
集成 TUIRoom (Web)
集成 TUIRoom (Android)
集成 TUIRoom (iOS)
集成 TUIRoom (Flutter)
集成 TUIRoom (Electron)
TUIRoom API 查询
实现云端录制与回放（旧）
监控仪表盘计费（旧）
协议与策略
安全合规认证
安全白皮书
信息安全说明
服务等级协议
苹果隐私策略：PrivacyInfo.xcprivacy
TRTC 政策
隐私协议
数据处理和安全协议
词汇表
文档实时音视频视频通话 SDK客户端 APIiOSTUICallKit（含 UI）

TUICallKit（含 UI）

PDF
聚焦模式
字号
最后更新时间： 2026-02-24 16:22:51

TUICallKit API 简介

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

API 概览

API
描述
创建 TUICallKit 实例（单例模式）。
设置用户的昵称、头像。
calls
发起单人或多人通话。
join
主动加入通话。
设置自定义来电铃音。
开启/关闭静音模式。
开启/关闭悬浮窗功能。
设置模糊背景。
开启/关闭来电横幅显示。
设置屏幕方向。

API 详情

createInstance

创建 TUICallKit 的单例。
Swift
public static func createInstance() -> TUICallKit

setSelfInfo

设置用户昵称、头像。用户昵称不能超过 500 字节，用户头像必须是 URL 格式。
Swift
public func setSelfInfo(nickname: String, avatar: String, completion: CompletionClosure?)
参数
类型
含义
nickname
String
用户昵称。
avatar
String
用户头像（格式为 URL）。
completion
CompletionClosure
异步操作的结果回调。

calls

发起通话。
Swift
public func calls(userIdList: [String], callMediaType: CallMediaType, params: CallParams?, completion: CompletionClosure?)
参数如下表所示：
参数
类型
含义
userIdList
[String]
目标用户的 userId 列表。
callMediaType
通话的媒体类型，例如视频通话、语音通话。
params
通话扩展参数，例如：房间号、通话邀请超时时间等。
completion
CompletionClosure
异步操作的结果回调。

join

主动加入通话。
Swift
public func join(callId: String, completion: CompletionClosure?)
参数如下表所示：
参数
类型
含义
callId
String
此次通话的唯一 ID。
completion
CompletionClosure
异步操作的结果回调。

setCallingBell

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

enableMuteMode

开启/关闭静音模式。
默认为 false，开启后，收到通话请求，不会播放来电铃声。
Swift
public func enableMuteMode(enable: Bool)

enableFloatWindow

开启/关闭悬浮窗功能。
默认为false，通话界面左上角的悬浮窗按钮隐藏，设置为 true 后显示。
Swift
public func enableFloatWindow(enable: Bool)

enableVirtualBackground

设置模糊背景。
默认为 false。
public func enableVirtualBackground(enable: Bool)

enableIncomingBanner

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

setScreenOrientation

设置屏幕方向。
默认为竖屏，orientation：0-竖屏、1-横屏、2-自动。
public func setScreenOrientation(orientation: Int, completion: CompletionClosure?)
参数如下表所示：
参数
类型
含义
orientation
Int
屏幕方向适配：0-纵向固定（Portrait），1-横向固定（Landscape），2-自动旋转（Auto）
completion
CompletionClosure
异步操作的结果回调

废弃接口

call

拨打电话（1v1通话）。
注意：
建议使用 calls 接口。
Objective-C
Swift
- (void)call:(NSString *)userId callMediaType:(TUICallMediaType)callMediaType;
public func call(userId: String, callMediaType: TUICallMediaType)
参数如下表所示：
参数
类型
含义
userId
NSString
目标用户的 userId
callMediaType
通话的媒体类型，例如视频通话、语音通话

call

拨打电话（1v1通话），支持自定义房间号、通话邀请超时时间，离线推送内容等。
注意：
建议使用 calls 接口。
Objective-C
Swift
- (void)call:(NSString *)userId callMediaType:(TUICallMediaType)callMediaType params:(TUICallParams *)params succ:(TUICallSucc __nullable)succ fail:(TUICallFail __nullable)fail;
public func call(userId: String, callMediaType: TUICallMediaType, params: TUICallParams,
                     succ: @escaping TUICallSucc, fail: @escaping TUICallFail)
参数如下表所示：
参数
类型
含义
userId
NSString
目标用户的 userId。
callMediaType
通话的媒体类型，例如视频通话、语音通话。
params
通话扩展参数，例如：房间号、通话邀请超时时间，离线推送自定义内容等。

groupCall

发起群组通话。
注意：
建议使用 calls 接口。
使用群组通话前需要创建 Chat 群组，如果已经创建，请忽略。
群组的创建详见：Chat 群组管理 ，或者您也可以直接使用 Chat TUIKit，一站式集成聊天、通话等场景。
Objective-C
Swift
- (void)groupCall:(NSString *)groupId userIdList:(NSArray<NSString *> *)userIdList callMediaType:(TUICallMediaType)callMediaType;Objective-C
public func groupCall(groupId: String, userIdList: [String], callMediaType: TUICallMediaType)
参数
类型
含义
groupId
NSString
此次群组通话的群 ID。
userIdList
NSArray
目标用户的 userId 列表。
callMediaType
通话的媒体类型，例如视频通话、语音通话。

groupCall

发起群组通话，支持自定义房间号、通话邀请超时时间，离线推送内容等。
注意：
建议使用 calls 接口。
使用群组通话前需要创建 Chat 群组，如果已经创建，请忽略。
群组的创建详见：Chat 群组管理 ，或者您也可以直接使用 Chat TUIKit，一站式集成聊天、通话等场景。
Objective-C
Swift
- (void)groupCall:(NSString *)groupId userIdList:(NSArray<NSString *> *)userIdList callMediaType:(TUICallMediaType)callMediaType params:(TUICallParams *)params succ:(TUICallSucc __nullable)succ fail:(TUICallFail __nullable)fail;
public func groupCall(groupId: String, userIdList: [String], callMediaType: TUICallMediaType, params: TUICallParams, succ: @escaping TUICallSucc, fail: @escaping TUICallFail)
参数
类型
含义
groupId
NSString
此次群组通话的群 ID。
userIdList
NSArray
目标用户的 userId 列表。
callMediaType
通话的媒体类型，例如视频通话、语音通话。
params
通话扩展参数，例如：房间号、通话邀请超时时间，离线推送自定义内容等。

joinInGroupCall


加
入群组中已有的音视频通话。
注意：
建议使用 join 接口。
加入群组中已有的音视频通话前，需要提前创建或加入 IM 群组，并且群组中已有用户在通话中，如果已经创建，请忽略。
群组的创建详见：Chat 群组管理 ，或者您也可以直接使用 Chat TUIKit，一站式集成聊天、通话等场景。
Swift
Objective-C
public func joinInGroupCall(roomId: TUIRoomId, groupId: String, callMediaType: TUICallMediaType)
- (void)joinInGroupCall:(TUIRoomId *)roomId groupId:(NSString *)groupId callMediaType:(TUICallMediaType)callMediaType;
参数
类型
含义
roomId
TUIRoomId
此次通话的音视频房间 ID。
groupId
String
此次群组通话的群 ID。
callMediaType
通话的媒体类型，例如视频通话、语音通话。

上一篇: API 概览下一篇: CallStore（无 UI）

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈