动态与公告

产品动态

产品近期公告

关于 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

Companion Transcription 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 政策

隐私协议

数据处理和安全协议

词汇表

TUICallKit

PDF

聚焦模式

字号

最后更新时间： 2025-03-27 15:25:59

TUICallKit API 简介
TUICallKit API 是音视频通话组件的含 UI 接口，使用TUICallKit API，您可以通过简单接口快速实现一个类微信的音视频通话场景，更详细的接入步骤，详情请参见 快速接入（TUICallKit）。
API 概览
API
描述
﻿login﻿
登录
﻿logout﻿
登出
﻿setSelfInfo﻿
设置用户的昵称、头像
﻿calls﻿
发起通话
﻿join﻿
主动加入通话
﻿enableMuteMode﻿
开启/关闭静音模式
﻿enableFloatWindow﻿
开启/关闭悬浮窗功能
﻿setCallingBell﻿
自定义来电铃声
﻿enableVirtualBackground﻿
开启/关闭虚拟背景功能
API 详情
login
登录。
Future<TUIResult> login(int sdkAppId, String userId, String userSig);
参数
类型
含义
sdkAppId
int
用户 SDKAppID。
userId
String
用户 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（_）。
userSig
String
用户签名 userSig。
userSig 通过使用 SDKSecretKey 对 sdkAppId、userId 等信息进行加密得到（计算方法详见），它是一个鉴权用的票据，用于腾讯云识别当前用户是否能够使用 TRTC 的服务。
返回值
﻿TUIResult﻿
包含 code 和 message 信息：code 为空 ("") 表示调用成功；code 不为空 ("") 表示调用失败，失败原因见 message。
logout
登出。
Future<void> logout()
setSelfInfo
设置用户昵称、头像。用户昵称不能超过500字节，用户头像必须是 URL 格式。
Future<TUIResult> setSelfInfo(String nickname, String avatar)
参数
类型
含义
nickName
String
目标用户的昵称，非必填
avatar
String
目标用户的头像，非必填
返回值
﻿TUIResult﻿
包含 code 和 message 信息：code 为空 ("") 表示调用成功；code 不为空 ("") 表示调用失败，失败原因见 message
calls
发起通话。v2.9+ 版本支持。
Future<TUIResult> calls(List<String> userIdList, TUICallMediaType mediaType, TUICallParams params)
参数
类型
含义
userIdList
List<String>
目标用户的userId 列表
callMediaType
﻿TUICallMediaType﻿
通话的媒体类型，比如：TUICallMediaType.video 或  TUICallMediaType.audio
params
﻿TUICallParams﻿
可选通话扩展参数，例如：房间号、通话邀请超时时间，离线推送自定义内容等
join
主动加入通话。v2.9+ 版本支持。
Future<void> join(String callId)
参数
类型
含义
callId
String
此次通话的唯一 ID
enableMuteMode
开启/关闭静音模式。
Future<void> enableMuteMode(bool enable)
参数
类型
含义
enable
bool
开启、关闭静音；true 表示开启静音
enableFloatWindow
开启/关闭悬浮窗功能，设置为 false 后，通话界面左上角的悬浮窗按钮会隐藏。
Future<void> enableFloatWindow(bool enable)
参数
类型
含义
enable
bool
开启、关闭悬浮窗功能；true 表示开启浮窗
setCallingBell
自定义来电铃声。
Future<void> setCallingBell(String assetName)
参数
类型
含义
assetName
String
铃声的路径，需要将铃声文件添加至主工程的 assets 资源中。
enableVirtualBackground
开启/关闭虚拟背景功能，开启虚拟背景功能后，您可以在 UI 上显示模糊背景的功能按钮，点击按钮可直接启用模糊背景功能。
Future<void> enableVirtualBackground(bool enable)
参数
类型
含义
enable
bool
开启、关闭静音；true 表示开启静音
废弃接口
call
拨打电话（1v1通话）。
注意：
该接口已在 v2.9+ 版本废弃，建议使用 calls 接口替代。
Future<void> call(String userId, TUICallMediaType callMediaType, [TUICallParams? params])
﻿
参数
类型
含义
userId
String
目标用户的 userID
callMediaType
﻿TUICallMediaType﻿
通话的媒体类型，比如：TUICallMediaType.video 或  TUICallMediaType.audio
groupCall
发起群组通话，注意：使用群组通话前需要创建 IM 群组，如果已经创建，请忽略。
注意：
该接口已在 v2.9+ 版本废弃，建议使用 calls 接口替代。
Future<void> groupCall(String groupId, List<String> userIdList, TUICallMediaType callMediaType,[TUICallParams? params])
参数
类型
含义
groupId
String
此次群组通话的群 ID
userIdList
List<String>
目标用户的userId 列表
callMediaType
﻿TUICallMediaType﻿
通话的媒体类型，比如：TUICallMediaType.video 或  TUICallMediaType.audio
joinInGroupCall
加入群组中已有的音视频通话。
注意：
该接口已在 v2.9+ 版本废弃，建议使用 join 接口替代。
Future<void> joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType callMediaType)
参数
类型
含义
roomId
﻿TUIRoomID﻿
此次通话的音视频房间 ID
groupId
String
此次群组通话的群 ID
callMediaType
﻿TUICallMediaType﻿
通话的媒体类型，比如：TUICallMediaType.video 或  TUICallMediaType.audio

帮助和支持

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

您也可以联系销售或提交工单以寻求帮助。

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

文档反馈

tencent cloud

实时音视频

TUICallKit

TUICallKit API 简介

API 概览

API 详情

logout

setSelfInfo

calls

join

enableMuteMode

enableFloatWindow

setCallingBell

enableVirtualBackground

废弃接口

call

groupCall

joinInGroupCall

帮助和支持

API	描述
login	登录
logout	登出
setSelfInfo	设置用户的昵称、头像
calls	发起通话
join	主动加入通话
enableMuteMode	开启/关闭静音模式
enableFloatWindow	开启/关闭悬浮窗功能
setCallingBell	自定义来电铃声
enableVirtualBackground	开启/关闭虚拟背景功能

参数	类型	含义
sdkAppId	int	用户 SDKAppID。
userId	String	用户 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（_）。
userSig	String	用户签名 userSig。 userSig 通过使用 SDKSecretKey 对 sdkAppId、userId 等信息进行加密得到（计算方法详见），它是一个鉴权用的票据，用于腾讯云识别当前用户是否能够使用 TRTC 的服务。
返回值	TUIResult	包含 code 和 message 信息：code 为空 ("") 表示调用成功；code 不为空 ("") 表示调用失败，失败原因见 message。