function bbb_api_create in BigBlueButton 6

Same name in this branch

1. 6 includes/api-0.64.bbb.inc \bbb_api_create()
2. 6 includes/api-0.7.bbb.inc \bbb_api_create()

Same name and namespace in other branches

1. 7 includes/api.bbb.inc \bbb_api_create()

Create Meeting (create)

Parameters

ARRAY $params: Associative array of additional url parameters. Components:

• name: STRING (REQUIRED) A name for the meeting.
• meetingID: STRING A meeting ID that can be used to identify this meeting by the third party application. This must be unique to the server that you are calling. If you supply a non-unique meeting ID, you will still have a successful call, but will receive a warning message in the response.
• attendeePW: STRING The password that will be required for attendees to join the meeting. This is optional, and if not supplied, BBB will assign a random password.
• moderatorPW: STRING The password that will be required for moderators to join the meeting or for certain administrative actions (i.e. ending a meeting). This is optional, and if not supplied, BBB will assign a random password.
• welcome: STRING A welcome message that gets displayed on the chat window when the participant joins. You can include keywords (%%CONFNAME%%, %%DIALNUM%%, %%CONFNUM%%) which will be substituted automatically. You can set a default welcome message on bigbluebutton.properties
• dialNumber: STRING The dial access number that participants can call in using regular phone. You can set a default dial number on bigbluebutton.properties
• voiceBridge: STRING Voice conference number that participants enter to join the voice conference. Note that if you don't specify a voiceBridge parameter, the meetingID parameter is used. The default pattern for this is a 5-digit number, because in the default Asterisk configuration, this is the PIN that a dial-in user must enter to join the conference. If you want to change this pattern, you have to edit /etc/asterisk/bbb_extensions.conf
• logoutURL: STRING The URL that the BigBlueButton client will go to after users click the OK button on the 'You have been logged out message'. This overrides, the value for bigbluebutton.web.loggedOutUrl if defined in bigbluebutton.properties
• maxParticipants: NUMBER The maximum number of participants to allow into the meeting (including moderators). After this number of participants have joined, BBB will return an appropriate error for other users trying to join the meeting. A negative number indicates that an unlimited number of participants should be allowed (this is the default setting).

Return value

OBJECT or FALSE

• meetingID: STRING The meeting ID supplied by the third party app. It must be used in conjunction with a password in subsequent calls for joining or otherwise modifying a meeting's status.
• attendeePW: STRING The password that will be required for attendees to join the meeting. If you did not supply one, BBB will assign a random password.
• moderatorPW: STRING The password that will be required for moderators to join the meeting or for certain administrative actions (i.e. ending a meeting). If you did not supply one, BBB will assign a random password.

See also

http://code.google.com/p/bigbluebutton/wiki/API#Create_Meeting_(create)

1 call to bbb_api_create()

bbb_create_meeting in ./bbb.module

Create meeting

File

includes/api-0.7.bbb.inc, line 84

Big Blue Button - Enables universities and colleges to deliver a high-quality learning experience.

Code

function bbb_api_create($params = array()) {
  $query_string = bbb_api_generate_querystring(BBB_API_CREATE, $params);
  $request = BBB_API_BASE_URL . BBB_API_CREATE . '?' . $query_string;
  return bbb_api_execute_query($request);
}