tencent cloud

TUIConferenceInvitationManager
Download PDF
Last updated: 2025-10-09 15:16:48
TUIConferenceInvitationManager
Last updated: 2025-10-09 15:16:48
Download PDF
In-meeting invitation APIs. The functions on the page only support the Conference room type.

TUIConferenceInvitationManager

Function API
Description
invite member
cancel invitation
accept
accept invitation
reject
reject invitation
invitation list
on
off
Cancel TUIConferenceInvitationManagerEvents event monitoring

TUIConferenceInvitationManagerEvents

Event API
Description
Invitation callback received
Invitation handled on another device callback
Invitation cancelled callback
Invitation accepted callback
Invitation rejected callback
Invitation timeout callback
Invitation revoked by admin/room owner callback
New invitation callback
Invitation removed callback
Invitation status change callback

Struct Type

Function List
Description
Invitation information structure

Enumeration Types

Enumeration Types
Description
invitation status
Invite error code enumeration
Rejection reason enumeration

Function API Description

inviteUsers

invite member
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.inviteUsers({
      roomId: '12345',
      timeout: 60,
      userIdList,
      extensionInfo
})
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Room ID, roomId has a length limit of 64 bytes and only supports the following character set:
uppercase and lowercase English letters (a-zA-Z)
Digits (0-9)
space ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
timeout
number
optional
0
Timeout Time
userIdList
Array<string>
Required
[]
Member User ID list.
extensionInfo
string
optional
''
Extended information.

cancelInvitation

cancel invitation
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.cancelInvitation({
    roomId: '12345'; 
    userIdList: ['userId']
})
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Room ID, roomId has a length limit of 64 bytes and only supports the following character set:
uppercase and lowercase English letters (a-zA-Z)
Digits (0-9)
space ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
userIdList
Array<string>
Required
[]
Member User ID list.

accept

accept invitation
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.accept({
    roomId: '12345'; 
})
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Room ID, roomId has a length limit of 64 bytes and only supports the following character set:
uppercase and lowercase English letters (a-zA-Z)
Digits (0-9)
space ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,

reject

reject invitation
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.reject({
    roomId: '12345'; 
})
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Room ID, roomId has a length limit of 64 bytes and only supports the following character set:
uppercase and lowercase English letters (a-zA-Z)
Digits (0-9)
space ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,

getInvitationList

invitation list
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
await conferenceInvitationManager.reject({
    roomId: '12345';
    cursor: '';
    count: 10;
})
Parameter
Type
Description
Default Value
Description
roomId
string
Required
-
Room ID, roomId has a length limit of 64 bytes and only supports the following character set:
uppercase and lowercase English letters (a-zA-Z)
Digits (0-9)
space ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
cursor
string
Required
''
Retrieve pagination index. For the first pull, enter "". If the callback succeeded and the returned data contains a non-empty cursor, it means pagination is required. Use the returned cursor as parameter to call the API again until the cursor is "", indicating all data has been pulled.
count
number
Required
0

Pull count this time.

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);
Parameter
Type
Required or Not
Default Value
Description
eventName
Yes
-
Event name.
func
(...args: any[]) => void
Yes
-
event handler

off

Cancel listening to TUIConferenceInvitationManagerEvents event.
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);
Parameter
Type
Required or Not
Default Value
Description
eventName
Yes
-
Event name.
func
(...args: any[]) => void
Yes
-
event handler


Event API Details

onReceiveInvitation

Invitation callback received
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);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.
extensionInfo
string
Extended information.

onInvitationHandledByOtherDevice

Invitation handled on another device callback
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, accepted }) => {
  console.log('conferenceInvitationManager.onInvitationHandledByOtherDevice', roomInfo, accepted);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationHandledByOtherDevice, callback);
Parameter
Type
Description
roomInfo
Room information.
accepted
boolean
Whether the invitation is accepted.

onInvitationCancelled

Invitation cancelled callback
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
  console.log('conferenceInvitationManager.onInvitationCancelled', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationCancelled, callback);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.

onInvitationAccepted

Invitation accepted callback
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
  console.log('conferenceInvitationManager.onInvitationAccepted', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAccepted, callback);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.

onInvitationRejected

Invitation rejected callback
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);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.
reason
Reason for rejection.

onInvitationTimeout

Invitation timeout callback
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
  console.log('conferenceInvitationManager.onInvitationTimeout', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationTimeout, callback);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.

onInvitationRevokedByAdmin

Invitation revoked by admin/room owner callback
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);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.
operateUser
Information of the person who revoked the invitation

onInvitationAdded

New invitation callback
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
  console.log('conferenceInvitationManager.onInvitationAdded', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, callback);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.

onInvitationRemoved

Invitation removed callback
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
  console.log('conferenceInvitationManager.onInvitationRemoved', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, callback);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.

onInvitationStatusChanged

Invitation status change callback
const roomEngine = new TUIRoomEngine();
const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
const callback = ({ roomInfo, invitation }) => {
  console.log('conferenceInvitationManager.onInvitationStatusChanged', roomInfo, invitation);
};
conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, callback);
Parameter
Type
Description
roomInfo
Room information.
invitation
Invitation message.

Struct Type Details

TUIInvitation

Invitation information structure
Enumeration Types
Description
invitee
Invitee information.
inviter
Inviter information.
status
Invitation status.

Enumeration Type Details

TUIInvitationStatus

invitation status
Enumeration
Value
Description
NONE
0
Unknown status.
PENDING
1
Pending status.
TIMEOUT
2
Timeout status.
ACCEPTED
3
Accepted status.
REJECTED
4
Rejected status.

TUIInvitationCode

Invite error code enumeration
Enumeration
Value
Description
SUCCESS
0
Invitation succeeded.
ALREADY_IN_INVITATION_LIST
1
The current user is already in the invitation list.
ALREADY_IN_CONFERENCE
2
The current user is in the room.

TUIInvitationRejectedReason

Rejection reason enumeration
Enumeration
Value
Description
REJECT_TO_ENTER
0
Access denied.
IN_OTHER_CONFERENCE
1
In another meeting.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback