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

类型定义

常用结构

TUIResult

调用 API 的返回值
类型
类型
描述
code
String
code 为空 "" 表示调用成功,code 不为空 "" 表示调用失败
message
String?
失败原因

TUIRoomId

房间 ID
类型
类型
描述
intRoomId
int
数字房间号
strRoomId
String
字符串房间号

VideoRenderParams

视频画面的渲染参数
类型
类型
描述
fillMode
FillMode
视频画面填充模式
rotation
Rotation
视频画面旋转方向

VideoEncoderParams

视频编码参数
类型
类型
描述
resolution
视频分辨率
resolutionMode
视频宽高比模式

TUICallParams

通话参数
类型
类型
描述
roomId
TUIRoomId
房间 ID
offlinePushInfo
厂商离线推送配置信息
timeout
String
超时时常
userData
String
用户自定义数据

TUIOfflinePushInfo

厂商离线推送配置信息,详情配置步骤请参考:离线唤醒
类型
类型
描述
title
String
离线推送展示通知栏标题
desc
String
离线推送展示通知栏内容
ignoreIOSBadge
bool
离线推送忽略 badge 计数(仅对 iOS 生效), 如果设置为 true,在 iOS 接收端,这条消息不会使 APP 的应用图标未读计数增加
iOSSound
String
离线推送声音设置(仅对 iOS 生效)。 当 sound = IOS_OFFLINE_PUSH_NO_SOUND,表示接收时不会播放声音。 当 sound = IOS_OFFLINE_PUSH_DEFAULT_SOUND,表示接收时播放系统声音。 如果要自定义 iOSSound,需要先把语音文件链接进 Xcode 工程,然后把语音文件名(带后缀)设置给 iOSSound
androidSound
String
离线推送声音设置(仅对 Android 生效, IMSDK 6.1 及以上版本支持)。 只有华为和谷歌手机支持设置声音提示,小米手机设置声音提示,请您参照:小米自定义铃声。 另外,谷歌手机 FCM 推送在 Android 8.0 及以上系统设置声音提示,必须调用 setAndroidFCMChannelID 设置好 channelID,才能生效
androidOPPOChannelID
String
离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID
androidVIVOClassification
int
VIVO 推送消息分类 (待废弃接口,VIVO 推送服务于 2023 年 4 月 3 日优化消息分类规则,推荐使用 setAndroidVIVOCategory 设置消息类别)。0:运营消息 1:系统消息,默认取值为 1
androidXiaoMiChannelID
String
小米手机 8.0 系统及以上的渠道 ID
androidFCMChannelID
String
FCM 通道手机 8.0 系统及以上的渠道 ID
androidHuaWeiCategory
String
华为推送消息分类,详见:华为消息分类标准
isDisablePush
bool
是否关闭推送(默认开启推送)
iOSPushType
iOS 离线推送类型,默认:APNs

TUICallRecords

通话记录信息
类型
类型
描述
callId
String
通话记录ID
inviter
String
邀请者ID
inviteList
List<String>
被邀请用户ID列表
scene
通话场景
mediaType
通话媒体类型
groupId
String
群组ID
role
通话角色
result
通话结果类型
beginTime
int
开始时间
totalTime
int
总时间

TUICallRecentCallsFilter

通话记录过滤条件
类型
类型
描述
begin
double
开始时间
end
double
结束时间
resultType
通话记录类型

枚举定义

TUICallMediaType

通话类型
类型
取值
描述
none
0
未知类型
audio
1
语音通话
video
2
视频通话

TUICallRole

通话角色
类型
取值
描述
none
0
未知类型
caller
1
主叫(邀请方)
called
2
被叫(被邀请方)

TUICallStatus

通话状态
类型
取值
描述
none
0
未知类型
waiting
1
通话等待中
accept
2
通话已接听

TUICallScene

通话场景
类型
取值
描述
groupCall
0
群组通话
multiCall
1
匿名群组通话(暂不支持,敬请期待)
singleCall
2
单人通话

TUINetworkQuality

网络质量
类型
取值
描述
unknown
0
未定义
excellent
1
当前网络非常好
good
2
当前网络比较好
poor
3
当前网络一般
bad
4
当前网络较差
vBad
5
当前网络很差
down
6
当前网络不满足通话的最低要求

FillMode

视频画面填充模式
类型
取值
描述
fill
0
填充模式:即将画面内容居中等比缩放以充满整个显示区域,超出显示区域的部分将会被裁剪掉,此模式下画面可能不完整。
fit
1
适应模式:即按画面长边进行缩放以适应显示区域,短边部分会被填充为黑色,此模式下图像完整但可能留有黑边。

Rotation

视频画面旋转方向
类型
取值
描述
rotation_0
0
不旋转
rotation_90
1
顺时针旋转90度
rotation_180
2
顺时针旋转180度
rotation_270
3
顺时针旋转270度

ResolutionMode

视频宽高比模式
类型
取值
描述
landscape
0
横屏分辨率,例如:Resolution.Resolution_640_360 + ResolutionMode.Landscape = 640 × 360。
portrait
1
竖屏分辨率,例如:Resolution.Resolution_640_360 + ResolutionMode.Portrait = 360 × 640。

Resolution

视频分辨率
类型
取值
描述
resolution_640_360
0
宽高比 16:9;分辨率 640x360;建议码率(VideoCall)500kbps
resolution_640_480
1
宽高比 4:3;分辨率 640x480;建议码率(VideoCall)600kbps
resolution_960_540
2
宽高比 16:9;分辨率 960x540;建议码率(VideoCall)850kbps
resolution_960_720
3
宽高比 4:3;分辨率 960x720;建议码率(VideoCall)1000kbps
resolution_1280_720
4
宽高比 16:9;分辨率 1280x720;建议码率(VideoCall)1200kbps
resolution_1920_1080
5
宽高比 16:9;分辨率 1920x1080;建议码率(VideoCall)2000kbps

TUICallIOSOfflinePushType

iOS离线推送类型
类型
取值
描述
APNs
0
普通推送
VoIP
1
VoIP 推送

TUICamera

摄像头类型类型
类型
取值
描述
front
0
前置摄像头
back
1
后置摄像头

TUIAudioPlaybackDevice

音频播放路由
类型
取值
描述
speakerphone
0
扬声器
earpiece
1
耳麦

TUICallResultType

通话记录类型
类型
取值
描述
unknown
0
未知
missed
1
未接
incoming
2
接入
outgoing
3
拨出