邀请

功能介绍

邀请者向其他用户发起邀请，被邀请者接受后加入该房间进行通讯。

使用场景：

会前邀请在线用户：会议开始前，邀请其他已登录用户加入指定房间。
会中邀请在线用户：会议进行中，邀请更多已登录用户加入当前房间。

使用注意点：

被邀请者只有成功登录了，才可以收到被邀请通知，否则无法收到邀请消息。
被邀请者可以同时收到多个邀请，应用层可以选择接受某个邀请。
邀请被接受/拒绝后，邀请任务自动结束，不与后续流程相关联（与呼叫中 call session 持续存在不同）。

注意：

须登录成功后方可使用邀请功能

邀请方

1.发起邀请

调用接口：

// A 邀请用户 B 加入房间 12345678，userExtDat 中携带目标房间号
var userExtDat = '{"meeting":{"ID":12345678}}';
var inviteID = CRVideo_Invite(invitedUserID, userExtDat, cookie);

回调通知：

// 邀请发送成功
CRVideo_InviteSuccess.callback = function(inviteID, cookie){
}

// 邀请发送失败
CRVideo_InviteFail.callback = function(inviteID, sdkErr, cookie){
    // sdkErr 为失败原因
}

邀请 SIP/H.323 设备、监控设备

须按接口要求填写 userExtDat（含房间号及设备信息等），分别参见 SIP/H.323 设备支持、监控设备对接。

相关API请参考：

2.邀请被接受/拒绝

回调通知：

// 通知邀请被接受
CRVideo_NotifyInviteAccepted.callback = function(inviteID, userExtDat){
    // 邀请被接受；若自己未入会则入会，若已在房间中可等待被邀请者入会；invite 请求已结束
}

// 通知邀请被拒绝
CRVideo_NotifyInviteRejected.callback = function(inviteID, reason, userExtDat){
    // reason 为拒绝原因；invite 请求已结束
}

相关API请参考：

3.取消邀请

仅在被邀请方尚未接受或拒绝前，邀请方可取消本次邀请。接受或拒绝后 invite 已结束，此时调用 CRVideo_CancelInvite 将没有效果。

调用接口：

// 取消邀请
CRVideo_CancelInvite(inviteID, userExtDat, cookie);

回调通知：

// 取消邀请成功
CRVideo_CancelInviteSuccess.callback = function(inviteID, cookie){
}

// 取消邀请失败
CRVideo_CancelInviteFail.callback = function(inviteID, sdkErr, cookie){
}

// 通知邀请被取消（被邀请方收到）
CRVideo_NotifyInviteCanceled.callback = function(inviteID, reason, userExtDat){
    // 邀请方已取消邀请，关闭邀请提示等处理
}

相关API请参考：

被邀请方

1.收到邀请

回调通知：

// 通知有邀请到来，inviterUserID 为邀请方用户 ID
CRVideo_NotifyInviteIn.callback = function(inviteID, inviterUserID, userExtDat){
    // 可从 userExtDat 中解析目标房间号，如：JSON.parse(userExtDat).meeting.ID
}

相关API请参考：

CRVideo_NotifyInviteIn

2.接受/拒绝邀请

调用接口：

// 接受邀请
CRVideo_AcceptInvite(inviteID, userExtDat, cookie);
// 从 NotifyInviteIn 的 userExtDat 解析出目标房间号后进入房间
CRVideo_EnterMeeting3(meetID, cookie);

// 拒绝邀请
CRVideo_RejectInvite(inviteID, userExtDat, cookie);

回调通知：

CRVideo_AcceptInviteSuccess.callback = function(inviteID, cookie){
    // 接受邀请成功，invite 请求结束，进入目标房间
}

CRVideo_AcceptInviteFail.callback = function(inviteID, sdkErr, cookie){
}

CRVideo_RejectInviteSuccess.callback = function(inviteID, cookie){
}

CRVideo_RejectInviteFail.callback = function(inviteID, sdkErr, cookie){
}

被邀请方相关API请参考：