会中邀请
1. 配置邀请模式
setCustomInviteType
会议中邀请分三种模式:呼叫邀请模式、自定义邀请 UI 模式、自定义邀请数据模式。
在会议主程序界面底部工具条上,“主持人/联席主持人”身份时,可以看到邀请按钮。
通过 setCustomInviteType 接口,可配置 SDK 使用哪种邀请模式。不配置的情况下,将使用:呼叫邀请模式。
如果想完全不显示邀请按钮,可使用 自定义配置,将邀请按钮隐藏。
setCustomInviteType 须在 SDK init 成功之后调用。
取值说明:0 为呼叫邀请模式(默认);1 为自定义邀请 UI 模式;2 为自定义邀请数据模式。
await RTCMeetingSDK.setCustomInviteType(1);
2. 呼叫邀请模式
使用会议内置的呼叫邀请功能,用户在会议中点击邀请按钮,将从会议系统的企业架构选择被邀请人并发起邀请后,会议系统会对在线的被邀请人发起呼叫,被邀请方将收到 SDK 的回调通知。
因为只能对会议系统内的用户发起呼叫邀请,所以需要先把用户从业务系统同步到会议系统,详见后端 WEB API 用户管理 接口。
在会议中呼叫邀请:

SDK 将收到“邀请通知”:

接听后加入会议,邀请方将显示对方已入会:

notifyCallIn
被邀请时将收到通知消息。
RTCMeetingSDK.on('notifyCallIn', (data) => {
// data 中含 callID、caller、meetInfo 等;meetInfo 常见含 meetID、pswd 等,以实际回调为准
// 弹出被邀请提示界面
});
acceptCall
收到被邀请消息时,可以接受邀请并进入会议。
// 接受邀请(callID 来自 notifyCallIn 回调)
await RTCMeetingSDK.acceptCall(callID);
// 进入对应会议
await RTCMeetingSDK.joinMeeting({
meetID: meetingID,
pswd: meetingPswd,
});
declineCall
收到被邀请消息时,可以拒绝邀请。
// 拒绝邀请(callID 来自 notifyCallIn 回调)
await RTCMeetingSDK.declineCall(callID);
notifyCallInCanceled
收到被邀请消息时,但长时间不做出响应,或邀请方撤消了邀请,将收到“邀请被取消”通知:
RTCMeetingSDK.on('notifyCallInCanceled', (data) => {
const callID = data.callID;
// 销毁之前弹出的“邀请”界面
});
3. 自定义邀请 UI 模式
通常是配合 IM 使用,用户在会议 SDK 界面中点击邀请按钮,会议 SDK 会通过 notifyInviteBtnClicked 回调业务系统。
业务系统可以高度定制邀请界面,并通过业务系统自已的信令通道或离线 push 通道完成邀请处理。
被邀请方在收到邀请消息后,调用 SDK 的 joinMeeting 或 joinMeetingWithoutLogin 加入被邀请会议即可。
notifyInviteBtnClicked
自定义邀请 UI 模式下,用户在会议 SDK 界面中点击“邀请按钮”时,将通过 notifyInviteBtnClicked 回调业务层。
RTCMeetingSDK.on('notifyInviteBtnClicked', (data) => {
// 打开业务自定义邀请流程
});
4. 自定义邀请数据模式
通常是配合 IM 使用,用户在会议 SDK 界面中点击邀请按钮,会议 SDK 会显示从业务系统查询得到的企业架构和用户。
邀请选择确认时,会议 SDK 回调业务系统选择内容,由业务系统自已的信令通道或离线 push 通道完成邀请处理。
被邀请方在收到邀请消息后,调用 SDK 加入会议即可。
会议中邀请选人界面:

业务收到邀请人员时,可向对应人发送一条会议通知:

notifyQueryOrgInfo
自定义邀请模式下,会议程序进入“邀请界面”时,将通过 notifyQueryOrgInfo 回调业务层请求获得“企业组织结构”数据。
RTCMeetingSDK.on('notifyQueryOrgInfo', () => {
// 应尽快将最新的数据送给 SDK
RTCMeetingSDK.setCustomOrgInfo({
contactData: [{ departId: 1, userId: '100', userName: 'test' }],
contactDepartsData: [{ departName: '测试部门', id: 1, pId: 0 }],
});
});
setCustomOrgInfo
自定义邀请模式下,收到 notifyQueryOrgInfo 回调时,应尽快将最新的“企业组织结构”数据送给 SDK。
RTCMeetingSDK.setCustomOrgInfo({
contactData: [{ departId: 1, userId: '100', userName: 'test' }],
contactDepartsData: [{ departName: '测试部门', id: 1, pId: 0 }],
});
notifyInviteUsers
自定义邀请模式下,用户选择了邀请人员后,SDK 将通过 notifyInviteUsers 通知选择人员。
RTCMeetingSDK.on('notifyInviteUsers', (data) => {
// 常见含待邀请用户列表等字段,例如 {"users":["userID1","userID2"]} 语义,以实际回调为准
});