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>
个人分类: 工作