BigBlueButton是一个视频会议软件,它的演示环境和开发环境的搭建,网上都有很多的资料,为了便于二次开发,我整理了一下BBB的常用功能API接口,供参考:
BigblueButton调用API,只需一个HTTP请求一个URL,查询参数提供呼叫所需要的信息,API返回一个XML响应;
BigblueButton 0.81 API分为三大类,描述管理功能的API方法、描述监控功能的API方法、描述录制功能的API方法,每个模块有自己的URL接口;
一、管理(描述管理功能的API方法):
1. 创建会议(create):
参数 |
必需/可选 |
类型 |
描述 |
name |
可选 |
String |
会议名称 |
meetingID |
必需 |
String |
会议ID被第三方应用程序用于识别本次会议。对服务器来说,正在调用的会议ID必须是唯一的 |
attendeePW |
可选 |
String |
用户加入会议密码 |
moderatorPW |
可选 |
String |
创建者管理密码 |
welcome |
可选 |
String |
欢迎词。当与会者进入会议时,该欢迎信息会显示在聊天窗口上,可以设置一个默认的欢迎信息在bigbluebutton.properties属性配置文件中 |
diaNumber | 选 |
String |
与会者使用普通电话接入会议的拨号号码,可以在bigbluebutton.properties属性配置文件中设置一个默认的拨号号码 |
voiceBridge |
可选 |
String |
与会者加入语音电话会议的语音电话会议号码。在默认的 Asterisk设置中,它是一个PIN密码,5位数字,拨号用户必须输入该密码才能参加会议,如果想要改变这种模式,必须编辑/etc/asterisk/bbb_extensions.conf文件。如果使用的是默认FreeSWITCH的设置,建议总是通过一个5位数的voiceBridge参数—数字'7'开始。如果不为voiceBridge传递一个值,那么用户将不能够参加一个会议的语音会议 |
webVoice |
可选 |
String |
参与者进入加入语音会议的语音会议alphanumberic |
logoutURL |
可选 |
String |
点击“你已从会议中登出”的OK按钮时转入的URL,这个参数可以取代bigbluebutton.properties中bigbluebutton.web.loggedOutURL属性的定义 |
record |
可选 |
String |
设定“record= true' 表示BigBlueButton的服务器会话中的媒体和事件将被录制供以后播放。可用的值是true或false。默认值是false |
duration |
可选 |
number |
指定会议的长度,即会议的持续时间。当到达的时间,BigBlueButton自动结束了会议。默认为0,这意味着会议继续进行,直到最后一个人离开或结束API调用相关meetingID |
meta |
可选 |
String |
创建会议时指定一个或多个元数据值。这些将被BBB存储,以备以后通过getMeetingInfo和getRecording调用来检索 |
创建会议URL实例:
http://yourserver.com/bigbluebutton/api/create?name=Test+Meeting&meetingID=abcdef