即时通信 IM iOS（快速接入）

二、环境要求

·iOS 系统版本要求：iOS 13.0 及以上。

·开发工具版本要求：Xcode 13 及以上版本，Xcode 15 及以上版本可能会遇到 Sandbox 错误，请参见 Sandbox 问题解决方案 进行修复。

·依赖管理工具要求：CocoaPods 环境安装。

·设备需满足：搭载 iOS 13.0 及以上系统的 iPhone、iPad 等 Apple 移动设备（确保应用可正常安装与运行）。

三、开通服务

在使用腾讯云提供的音视频服务前，你需要前往控制台，为应用开通音视频服务。具体步骤详细参见 开通服务。开通服务后，请记录 SDKAppID 和 SDKSecretKey，在后续的（登录）步骤中会用到。

五、步骤1：导入组件

1. 添加 Pod 依赖。

若项目已有 Podfile 文件在你项目的 Podfile 文件中添加 pod 'TUICallKit_Swift' 依赖。例如：target 'YourProjectTarget' do pod 'TUICallKit_Swift'end

若项目没有 Podfile 文件在终端中进入到你的 .xcodeproj 目录下，然后执行 pod init 命令创建 Podfile 文件，创建完成后，在你的 Podfile 文件中添加 pod 'TUICallKit_Swift'依赖。例如:// 1 终端中进入到你的 .xcodeproj 目录下cd /Users/yourusername/Projects/YourProject// 2pod init// 3 在生成的 Podfile 文件中target 'YourProjectTarget' do pod 'TUICallKit_Swift'end

2. 安装组件。

在终端进入到 Podfile 文件所在的目录，然后执行以下命令安装组件。

pod install –repo-update

注意：提示：

注意：安装完成后，使用 YourProjectName.xcworkspace 文件打开项目

六、步骤2：工程配置

为了使用音视频功能，你的应用需要获取麦克风和摄像头的权限。请在应用的 Info.plist 文件中添加以下两项，并填写对应的使用说明，这些说明将在系统请求权限时向用户显示：

Info.plist 代码示例<key>NSCameraUsageDescription</key><string>TUICallKitApp 需要访问你的摄像头，并可用于视频通话、群组视频通话等功能。</string><key>NSMicrophoneUsageDescription</key><string>TUICallKitApp 需要访问你的麦克风，并可用于音频通话、群组音频通话、视频通话、群组视频通话等功能</string>

七、步骤3：登录

在你的项目中添加如下代码，调用 login 方法实现 TUI 组件的登录。这一步骤至关重要，只有在成功登录之后，你才能正常使用 TUICallKit 提供的各项功能。

login

import TUICoreimport TUICallKit_Swiftfunc application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { let userID = "denny" // 请替换为你的 UserId let sdkAppID: Int = 0 // 请替换为在控制台得到的 SDKAppID let secretKey = "****" // 请替换为在控制台得到的 SecretKey let userSig = GenerateTestUserSig.genTestUserSig(userID: userID, sdkAppID: sdkAppID, secretKey: secretKey) TUILogin.login(Int32(sdkAppID), userID: userID, userSig: userSig) { print("login success") } fail: { code, message in print("login failed, code: \\(code), error: \\(message ?? "nil")") } return true}

注意：说明：

八、步骤4：设置昵称和头像[可选]

首次登录的用户没有头像和昵称信息，你可以通过 setSelfInfo 接口设置头像和昵称：

setSelfInfo

import TUICallKit_Swiftimport AtomicXCoreTUICallKit.createInstance().setSelfInfo(nickname: "jack", avatar: "https://****/user_avatar.png", completion: { result in switch result { case .success: print("setSelfInfo success") case .failure(let error): print("setSelfInfo failed: \\(error)") @unknown default: break }})

九、步骤5：发起通话

拨打方可以通过调用 calls 函数，并指定通话类型和被叫方的 userID，来发起语音或视频通话。calls 接口同时支持一对一通话和多人通话。当 userIDList 中包含一个 userID 时，为一对一通话；当 userIDList 包含多个 userID 时，则为多人通话。

注意：calls 接口不能写在 viewDidLoad 方法中，应放在按钮的点击事件或其他用户交互的响应方法中调用。

calls

import TUICallKit_Swiftimport AtomicXCoreTUICallKit.createInstance().calls(userIdList: ["mike"], mediaType: .audio, params: nil, completion: { result in switch result { case .success: print("calls success") case .failure(let error): print("calls failed: \\(error)") @unknown default: break }})

十、步骤6：接听通话

接听端完成登录后，拨打端发起通话，接听端就可以收到通话邀请，同时伴随铃声和振动。

十一、AI 助手：知识咨询与代码集成

你在接入视频通话 SDK 过程中，可以通过 MCP 使用 AI 助手，快速完成知识咨询、报错排查和集成代码生成。支持 Web/Android/iOS/Flutter/uni-app/HarmonyOS 等平台，答案基于产品文档。适用于查询 CallKit 组件和无 UI SDK 用法以及集成文档等场景，立即体验，提出你的第一个问题。

十三、AI 转录与翻译

你可以通过调用 enableAITranscriber 开启/关闭 AI 转录与翻译功能。

enableAITranscriberimport TUICallKit_SwiftTUICallKit.createInstance().enableAITranscriber(enable: true)详情：默认为 true，通话界面上显示 AI 翻译相关页面，设置为 false 后关闭。

十四、开启悬浮窗功能

你可以通过调用 enableFloatWindow 开启/关闭悬浮窗功能，在初始化 TUICallKit 组件时启用该功能，默认状态为关闭（false）。可通过点击通话界面左上角的悬浮窗按钮，将通话界面缩小为悬浮窗形式。

enableFloatWindowimport TUICallKit_SwiftTUICallKit.createInstance().enableFloatWindow(enable: true)详情：默认为 false，通话界面左上角的悬浮窗按钮隐藏，设置为 true 后显示。

十五、开启来电横幅

你可以通过调用 enableIncomingBanner 开启/关闭来电横幅显示，该功能默认为关闭状态（false）。当被叫端收到来电时，默认展示全屏通话等待界面。启用此功能后，将首先显示一个横幅通知，然后根据需要切换到全屏通话界面。请注意，显示来电横幅需要授予悬浮窗权限，具体的显示策略将根据权限设置及应用当前是否在前台或后台运行来决定。

enbalecomingBannerimport TUICallKit_SwiftTUICallKit.createInstance().enableIncomingBanner(enable: true)详情：默认为 false，被叫端收到邀请后默认弹出全屏通话等待界面。开启后先展示一个横幅，然后根据需要拉起全屏通话界面。

十六、多人通话

主叫方使用 calls 方法发起通话时，若被叫用户列表超过一人，则自动视为群组通话。其他成员可通过 join 方法加入该多人通话。

·发起多人通话：使用 calls 方法发起通话时，若被叫用户列表（userIdList）超过一人，则自动视为群组通话。

calls

import TUICallKit_Swiftimport AtomicXCoreTUICallKit.createInstance().calls(userIdList: ["mike", "tate"], mediaType: .audio, params: nil, completion: { result in switch result { case .success: // 成功处理 case .failure(let error): // 失败处理 }})

·加入多人通话：可使用 join 方法加入指定的群组通话。

join

import TUICallKit_SwiftTUICallKit.createInstance().join(callId: "")

十七、语言设置

·支持的语言：目前支持简体中文、繁体中文、英文、日文和阿拉伯语。

·切换语言：TUICallKit 默认语言与手机系统保持一致 。如果需要切换语言，可以使用 TUIGlobalization.setPreferredLanguage 方法设置语言，以设置语言为英文示例的代码如下:

setLanguage

import TUICorefunc setLanguage() { TUIGlobalization.setPreferredLanguage("en")}

注意：说明：

注意：如需设置其他语言，请 联系我们 获取协助。

十八、铃声设置

你可通过以下方式设置默认铃声、来电静音模式、离线推送铃声：

·设置默认铃声（方式1）：如果你通过源码依赖 TUICallKit 组件，你可以替换铃声资源文件（发起呼叫时的铃音、接到呼叫时的铃音）设置默认铃声。

·设置默认铃声（方式2）：通过 setCallingBell 接口设置被叫端收到的来电铃声。

setCallingBell

import TUICallKit_SwiftTUICallKit.createInstance().setCallingBell(filePath: "***/callingBell.mp3")

详情：这里仅限传入本地文件地址，需要确保该文件目录是应用可以访问的。铃声设置后与设备绑定，更换用户，铃声依旧会生效。如需恢复默认铃声，filePath 传空即可。

·来电静音模式：你可以通过 enableMuteMode 设置静音模式。

enableMuteModeimport TUICallKit_SwiftTUICallKit.createInstance().enableMuteMode(enable: true)详情：开启后，收到通话请求，不会播放来电铃声。

·自定义离线推送铃声：离线推送默认铃声是由系统决定的，如果你需要自定义铃声，请按以下步骤操作：

1.1 准备自定义铃声：将你的铃声文件命名为 phone_ringing.mp3。

1.2 替换项目文件：替换项目中现有的同名铃声文件。

20、替换图标按钮

你可以直接替换 Resources/AtomicX.xcassets 文件夹下的图标，以确保整个 App 中的图标色调风格保持一致。以下列出了基本的功能按钮，你可以替换对应的图标以适配自己的业务场景。

常用图标文件名列表

22、TUIKit 是否支持后台运行？

支持，如需要进入后台仍然运行相关功能，可选中当前工程项目，在 Capabilities 下的 Background Modes 模块中勾选 Audio，AirPlay, and Picture in Picture ：

23、Xcode 出现 Sandbox: rsync 编译报错？

可以在 Build Settings 中把 User Script Sandboxing 设置为 NO：

如果你在接入和使用中遇到其他问题，请参见 常见问题。

24、交流与反馈

如果你在使用过程中，有什么建议或者意见，可以 联系我们，感谢你的反馈。