bigbluebutton中文社群 / 開放API / bbb API

_小李哥發表於2016-07-12
API

bigbluebutton中文社群 / 開放API / bbb API 
建立會議

這個介面可以重複呼叫多次，而不會有副作用。這帶來的好處就是能簡化應用程式加會的流程，無論什麼使用者想要加會，都可以先建立會議而不用擔心會議不存在。Bigbluebutton的伺服器會定期的檢查並清理那些 已經超時了的沒人加入的會議，這個會議超時時間由bydefaultMeetingCreateJoinDuration指定（在bigbluebutton.properties中，具體哪一個）。
注：有點不知所云，後面再修正吧
URL格式：
http://yourserver.com/bigbluebutton/api/create?[parameters]&checksum=[checksum]
引數：
引數名：name
必須或可選：必須
型別：字串
描述：會議的名稱

引數名：meetingID 
必須或可選：必須
型別：字串
描述：會議的ID，如果要使用會議錄製，則其中不能有逗號。ID必須唯一，不唯一會有警告訊息回覆（影響？）

引數名：attendeePW 
必須或可選：可選
型別：字串
描述：與會者的密碼，如果不指定，bigbluebutton會生成預設的隨機密碼

引數名：moderatorPW 
必須或可選：可選
型別：字串
描述：會議管理員的密碼，如果不指定，bigbluebutton會生成預設的隨機密碼

引數名：welcome 
必須或可選：可選
型別：字串
描述：歡迎資訊，可以使用如下這些關鍵字，(%%CONFNAME%%, %%DIALNUM%%, %%CONFNUM%%)，它們會被自動替換。也可以在bigbluebutton-web/grails-app/conf/bigbluebutton.properties中設定預設值

引數名：dialNumber
必須或可選：可選
型別：字串
描述：可以通過電話直接撥入語音會議的號碼。可以在bigbluebutton-web/grails-app/conf/bigbluebutton.properties中設定預設值

引數名：voiceBridge
必須或可選：可選
型別：字串
描述：通過電話撥入語音會議時需要輸入的PIN碼，如果不指定，使用者則不能夠通過這種方式加入。freeswitch的配置格式？

引數名：webVoice
必須或可選：可選
型別：字串
描述：通過WEB方式加入語音會議時需要輸入的PIN碼

引數名：logoutURL 
必須或可選：可選
型別：字串
描述：退出會議後的URL，覆蓋bigbluebutton-web/grails-app/conf/bigbluebutton.properties中的設定。

引數名：maxParticipants 
必須或可選：可選(NFS) 
型別：數字
描述：限制會議的最大人數，負值表示沒有上限

引數名：record 
必須或可選：可選
型別：bool
描述：是否錄製會議，預設為false

引數名：duration 
必須或可選：可選
型別：數字
描述：會議時長（分鐘為單位），超過時間後會議會自動結束。預設為0，會議不會自己結束，只有沒有使用者在會議中或者呼叫結束會議的API

引數名：meta 
必須或可選：可選
型別：字串
描述：會議的元資訊描述，包括meta_Presenter，meta_category，meta_label等（是自定義的嗎？），可以通過getMeetingInfo和getRecordings取到

例子
請求
http://yourserver.com/bigbluebutton/api/create?name=Test&meetingID=test01&checksum=1234 http://yourserver.com/bigbluebutton/api/create?name=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap&checksum=wxyz http://yourserver.com/bigbluebutton/api/create?name=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap&meta_presenter=joe&meta_category=education&checksum=abcd

回覆
<response> <returncode>SUCCESS</returncode> <meeting> <meetingID>Test</meetingID> <createTime>1308591802</createTime> <attendeePW>ap</attendeePW> <moderatorPW>mp</moderatorPW> <hasBeenForciblyEnded>false</hasBeenForciblyEnded> <messageKey>createSuccess</messageKey> <message>Meeting has been create</message> </meeting> </response>

預上傳演示文件

要上傳的文件資訊在HTTP post請求裡指定，Url和前面的一樣。有兩種方式指定，一種是指定一個文件的url，這樣bbb伺服器會去下載這個文件（同步還是非同步？），另一種方式是將文件用base64編碼。BBB伺服器預設處理的POST請求最大為2MB，所以需要注意一下。（哪裡可以改動？nginx配置？）

POST格式如下：
<?xml version="1.0" encoding="UTF-8"?> <modules> <module name="presentation"> <document url="http://www.samplepdf.com/sample.pdf" /> <document name="sample-presentation.pdf">JVBERi0xLjQKJ.... [clipped here] ....0CiUlRU9GCg== </document> </module> </modules>

相關文章