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 政策
隐私协议
数据处理和安全协议
词汇表

TUIConferenceInvitationManager

PDF
聚焦模式
字号
最后更新时间: 2025-10-09 15:16:18
会中邀请相关接口,此页面中的函数仅支持 Conference 房间类型。

TUIConferenceInvitationManager

函数接口
描述
邀请成员
取消邀请
accept
接受邀请
reject
拒绝邀请
拉取邀请列表
on
off

TUIConferenceInvitationManagerEvents

事件接口
描述
收到邀请回调
邀请已在其他设备被处理回调
邀请被取消回调
邀请被接受回调
邀请被拒绝回调
邀请超时回调
邀请被管理员/房主撤销回调
新增邀请回调
邀请被移除回调
邀请状态变更回调

结构体类型

函数列表
描述
邀请信息结构体

枚举类型

枚举类型
描述
邀请状态
邀请错误码枚举
邀请拒绝原因枚举

函数接口详情

inviteUsers

邀请成员
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.inviteUsers({
roomId: '12345',
timeout: 60,
userIdList,
extensionInfo
})
参数
类型
说明
默认
含义
roomId
string
必填
-
房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集:
大小写英文字母(a-zA-Z)
数字(0-9)
空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
timeout
number
非必填
0
超时时间。
userIdList
Array<string>
必填
[]
成员 userId 列表。
extensionInfo
string
非必填
''
扩展信息。

cancelInvitation

取消邀请
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.cancelInvitation({
roomId: '12345';
userIdList: ['userId']
})
参数
类型
说明
默认
含义
roomId
string
必填
-
房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集:
大小写英文字母(a-zA-Z)
数字(0-9)
空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
userIdList
Array<string>
必填
[]
成员 userId 列表。

accept

接受邀请
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.accept({
roomId: '12345';
})
参数
类型
说明
默认
含义
roomId
string
必填
-
房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集:
大小写英文字母(a-zA-Z)
数字(0-9)
空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,

reject

拒绝邀请
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.reject({
roomId: '12345';
})
参数
类型
说明
默认
含义
roomId
string
必填
-
房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集:
大小写英文字母(a-zA-Z)
数字(0-9)
空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,

getInvitationList

拉取邀请列表
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.reject({
roomId: '12345';
cursor: '';
count: 10;
})
参数
类型
说明
默认
含义
roomId
string
必填
-
房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集:
大小写英文字母(a-zA-Z)
数字(0-9)
空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
cursor
string
必填
''
分页获取索引,第一次拉取填 "",回调成功 如果callback返回的数据中 cursor 不为"",表示需要分页,请以返回的cursor作为参数再次调用接口拉取,直至返回的cursor为"",表示数据已经全部拉取。
count
number
必填
0

本次拉取数量。

on

const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, accepted, extensionInfo }) => {
console.log('conferenceInvitationManager.onReceiveInvitation', roomInfo, accepted, extensionInfo);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onReceiveInvitation, callback);
参数
类型
是否必填
默认值
说明
eventName
-
事件名。
func
(...args: any[]) => void
-
事件处理函数。

off

const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, accepted, extensionInfo }) => {
console.log('conferenceInvitationManager.onReceiveInvitation', roomInfo, accepted, extensionInfo);
};
conferenceInvitationManager.off(TUIConferenceInvitationManagerEvents.onReceiveInvitation, callback);
参数
类型
是否必填
默认值
说明
eventName
-
事件名。
func
(...args: any[]) => void
-
事件处理函数。


事件接口详情

onReceiveInvitation

收到邀请回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, accepted, extensionInfo }) => {
console.log('conferenceInvitationManager.onReceiveInvitation', roomInfo, accepted, extensionInfo);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onReceiveInvitation, callback);
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。
extensionInfo
string
扩展信息。

onInvitationHandledByOtherDevice

邀请已在其他设备被处理回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, accepted }) => {
console.log('conferenceInvitationManager.onInvitationHandledByOtherDevice', roomInfo, accepted);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationHandledByOtherDevice, callback);
参数
类型
描述
roomInfo
房间信息。
accepted
boolean
邀请是否被接受。

onInvitationCancelled

邀请被取消回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
console.log('conferenceInvitationManager.onInvitationCancelled', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationCancelled, callback);
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。

onInvitationAccepted

邀请被接受回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
console.log('conferenceInvitationManager.onInvitationAccepted', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAccepted, callback);
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。

onInvitationRejected

邀请被拒绝回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation, reason }) => {
console.log('conferenceInvitationManager.onInvitationRejected', roomInfo, invitation, reason);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRejected, callback);
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。
reason
拒绝原因。

onInvitationTimeout

邀请超时回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
console.log('conferenceInvitationManager.onInvitationTimeout', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationTimeout, callback);
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。

onInvitationRevokedByAdmin

邀请被管理员/房主撤销回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation, userRole }) => {
console.log('conferenceInvitationManager.onInvitationRevokedByAdmin', roomInfo, invitation, operateUser);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRevokedByAdmin, callback);
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。
operateUser
撤回邀请的人的信息

onInvitationAdded

新增邀请回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
console.log('conferenceInvitationManager.onInvitationAdded', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, callback);
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。

onInvitationRemoved

邀请被移除回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
console.log('conferenceInvitationManager.onInvitationRemoved', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, callback);
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。

onInvitationStatusChanged

邀请状态变更回调
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
console.log('conferenceInvitationManager.onInvitationStatusChanged', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, callback)
参数
类型
描述
roomInfo
房间信息。
invitation
邀请信息。

结构体类型详情

TUIInvitation

邀请信息结构体
枚举类型
描述
invitee
被邀请者信息。
inviter
邀请者信息。
status
邀请状态。

枚举类型详情

TUIInvitationStatus

邀请状态
枚举
取值
描述
NONE
0
未知状态。
PENDING
1
待处理状态。
TIMEOUT
2
超时状态。
ACCEPTED
3
已接受状态。
REJECTED
4
被拒绝状态。

TUIInvitationCode

邀请错误码枚举
枚举
取值
描述
SUCCESS
0
邀请成功。
ALREADY_IN_INVITATION_LIST
1
当前用户已在邀请列表。
ALREADY_IN_CONFERENCE
2
当前用户已在房间内。

TUIInvitationRejectedReason

邀请拒绝原因枚举
枚举
取值
描述
REJECT_TO_ENTER
0
拒绝进入。
IN_OTHER_CONFERENCE
1
在其他会议中。

帮助和支持

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

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

文档反馈