会议

调用Betalk会议模块集成到你的web应用程序中,使用该文件中提到的简单的JavaScript调用。

1. 开始会议

可选参数Betalk.meet()API请求

名称 描述
schedule_binder_id 从REST API请求会议表得到schedule_binder_id值 预定会议开始。请参考REST API附表符合
binder_id binder_id值 所述binder_id用于自动邀请所有讨论组成员invite_members被设置为“真”
invite_members True or false 默认为false。指定自动开始会议的时候邀请所有讨论组成员来自binder_id
UNIQUE_ID UNIQUE_ID(S)以逗号分隔的列表(,) 可选:初始的成员被邀请到会议
email 电子邮件(S)以逗号分隔的列表(,) 可选:初始的成员被邀请到会议
IFRAME True or false 默认为false。指定要启动的iframe或在新窗口中相遇
tab True or false 默认为false。指定要开始新的选项卡中相遇 – 适用前提IFRAME选项设置为“true”
tagid4iframe iFrame ID 指定的iframe容器的ID – 适用前提IFRAME在选项设置为“true”
border True or false 默认值为true。如果使用的iframe标签里面没有周围的iframe边框指定“false”
scroll True or false 默认为false。如果周围使用的iframe标签添加滚动条内的iframe指定“true”
iframewidth iFrame的宽度 宽度满足的iFrame的 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为1024px。如果容器控制的宽度,请设置为100%
iframeheight iFrame的高度 相见的iFrame的高度 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为768px。如果容器控制的高度,请设置为100%
video True or false 默认为false。指定“真”,如果你的应用程序需要视频会议
extension

下面扩展选项可与开始会议API一起使用

要显示或隐藏的邀请成员对话。默认为false

{ 
    "show_dialogs": { "meet_invite": true/false } 
}

自动保存在会议中共享共享内容,并自动记录会议视频内容。默认为false

{ 
    "save_meet": { 
        "auto_save": true/false, 
        "auto_record": true/false 
    }
}

要添加自己的CMS或存储库到添加文件选项

{ 
    "menus":[{"add_page":[
        {
            "menu_name":"My CMS",
            "position":"bottom"
        }]
    }]
}

监听器来处理自定义添加页面选项回调

add_page: function(event) {
    if (event.action == "My CMS") {
     alert ("Clicked on My CMS for Binder Id: " + event.binder_id);
    }
}
options

下面是补充会议级别选项:

基于此代码中提到的选项片断,你就可以控制某些会议功能的行为。默认情况下所有这些选项都设置为“假”

options: {
// Set to true will hide the invite option for Meet
"MEET_WITHOUT_INVITE": true, 

// Set to true will hide the invite option only to the attendees and not the host or presenter
"MEET_ATTENDEE_WITHOUT_INVITE": true,

// Set to true will hide the particpant panel for Meet
"MEET_WITHOUT_PARTICIPANT":true, 

// Set to true will hide the particpant panel only to the attendees and not the host or presenter
"MEET_ATTENDEE_WITHOUT_PARTICIPANT":true

// Set to true will hide annotation options to the the participants
"MEET_ATTENDEE_WITHOUT_ANNOTATE":true  

// Set to true will hide audio option for Meet
"MEET_WITHOUT_AUDIO": true, 

// Applicable only if MEET_WITHOUT_AUDIO is false. Set to true will hide VoIP audio option for Meet
"MEET_WITHOUT_AUDIO_VOIP": true,

// Applicable only if MEET_WITHOUT_AUDIO is false. Set to true will hide Dial-in audio option for Meet
"MEET_WITHOUT_AUDIO_DIALIN": true,

// Set to true will set the page sharing to full screen view
"SHOW_PAGE_AS_FULLSCREEN":true
}

 

Betalk开始通过侦听器处理会议回调事件

事件 描述 属性
start_meet(成功遗留使用) 触发会议成功的开始 session_key,SESSION_ID,binder_id
error 触发一个错误 ERROR_CODE,ERROR_MESSAGE
save_meet 会议保存时触发 session_key,SESSION_ID,binder_id
invite_meet 点击邀请按钮时触发 session_key,SESSION_ID,binder_id
end_meet 当会议由主机结束时触发
resume_meet 当会议因刷新页面重新加载时触发 session_key,SESSION_ID,binder_id
start_meet_sharing 当被触发时,屏幕共享激活 session_key,SESSION_ID
end_meet_sharing 当屏幕共享结束时触发 session_key,SESSION_ID
reach_limit 触发达到组织或用户的限制 session_id, error_code, type, 附加属性取决于 “type”

  • meet_duration_max:达到最大的会议时间;
  • attributes:value,remaining, session_key, binder_id

示例代码,在DIV中开始会议:

<div id="container" style="position:absolute; top:100px; left:150px;">
    DIV tag
</div>
<h3><a href="javascript:start();">Start Meet</a> within DIV</h3>

<script type="text/javascript">
function start() {
    var options = {
        iframe: true,
        extension: { "show_dialogs": { "meet_invite": true } },
        tagid4iframe: "container",
        iframewidth: "1000px",
        iframeheight: "750px",
        start_meet: function(event) {
            alert("session key: " + event.session_key + " session id: " + event.session_id + " binder id: " + event.binder_id);
        },
        error: function(event) {
            alert("error code: " + event.error_code + " message: " + event.error_message);
        },
        resume_meet: function(event) {
            alert("session key: " + event.session_key + " session id: " + event.session_id + " binder id: " + event.binder_id);
        },
        end_meet: function(event) {
            alert("Meet end event");
        }

2. 加入会议

参数,包括在加入符合API请求

名称 描述
session_key 从开始会议事件返回session_key值 Key 加入Betalk会议会话
user_name 用户的名称 如果用户登录到Betalk,名称将被自动地从他的Betalk信息检索。如果该值未设置的用户将在参与者列表显示为“Guest”
extension

下面扩展选项可与开始会议API一起使用

要显示或隐藏的邀请成员对话。默认为false。

{ 
    "show_dialogs": { "member_invite": true/false } 
}
IFRAME True or false 默认为false。指定要加入的满足在iframe或在一个新的窗口
Tab True or false 默认为false。指定要加入一个新的选项卡中相遇 – 适用前提IFRAME在选项设置为“true”
tagid4iframe iFrame的ID 指定的iframe容器的ID – 适用前提IFRAME在选项设置为“真”
border True or false 默认值为true。如果使用的iframe标签里面没有周围的iframe边框指定“假”
scroll True or false 默认为false。如果周围使用的iframe标签添加滚动条内的iframe指定“真”
iframewidth iFrame的宽度 宽度满足的iFrame的 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为1024px。如果容器控制的宽度,请设置为100%
iframeheight iFrame的高度 相见的iFrame的高度 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为768px。如果容器控制的高度,请设置为100%
video True or false 默认为false。指定“真”,如果你的应用程序将需要视频会议

Betalk加入通过监听器来处理满足回调事件

事件 描述 属性
start_meet(成功遗留使用) 触发会议成功的开始 session_key,SESSION_ID,binder_id
Error 触发一个错误 ERROR_CODE,ERROR_MESSAGE
save_meet 会议保存时触发 session_key,SESSION_ID,binder_id
invite_meet 点击邀请按钮时触发 session_key,SESSION_ID,binder_id
end_meet 当会议结束时触发
exit_meet 当与会者离开会议触发
reach_limit 触发达到组织或用户的限制 session_id, error_code, type, 附加属性取决于 “type”:

  • meet_duration_max:达到最大的会议时间;
  • attributes:value,remaining, session_key, binder_id

示例代码的加入满足无joinURL

var options = {
    session_key: key.value,
    user_name: "Joe Smith",
    iframe: true,
    extension: { "show_dialogs": { "meet_invite": true } },
    start_meet: function(event) {
        alert("session key: " + event.session_key + " session id: " + event.session_id);
    },
    error: function(event) {
        alert("error code: " + event.error_code + " message: " + event.error_message);
    },
    end_meet: function(event) {
        alert("Meet ended by host event");
    },
    exit_meet: function(event) {
        alert("Meet exit event");
    }
};

 3. 离开会议

通过离开会议api 回调事件处理

事件 描述 属性
error 触发一个错误的情况下 ERROR_CODE,ERROR_MESSAGE
exit_meet 当与会者离开会议触发

示例代码离开会议:

Betalk.leaveMeet();

 4. 结束会议

通过结束会议API回调事件处理

事件 描述 属性
error 触发一个错误的情况下 ERROR_CODE,ERROR_MESSAGE
end_meet 当会议结束时触发

示例代码结束会议:

Betalk.endMeet();

 5. 上传文件到会议中

使用返回的会话ID和会话密钥参数,成功开启后,你可以将文件上传到正在进行的会议。实现这个应用程序将文件上传到https://www.Betalk.com(用于生产)或https://sandbox.Betalk.com(对于沙盒):

POST/board/upload?type=original&sessionid=SESSION_ID&key=SESSION_KEY&name=FILE_NAME
Header Content-Type: application/octet-stream
File Content Sent as the body