function bbb_api_create in BigBlueButton 7

Same name and namespace in other branches

1. 6 includes/api-0.64.bbb.inc \bbb_api_create()
2. 6 includes/api-0.7.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 is optional, and if not supplied, BBB will generate a meeting token that can be used to identify the meeting.
• 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
• 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

@return OBJECT or FALSE

• meetingToken: STRING The internal meeting token assigned by the API for this meeting. It can be used by subsequent calls for joining or otherwise modifying a meeting's status.
• meetingID: STRING The meeting ID supplied by the third party app, or null if none was supplied. If can 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 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.bbb.inc, line 56

BigBlueButton - Enables universities and colleges to deliver a high-quality learning experience.

Code

function bbb_api_create($params = array()) {
  $response = bbb_api_call($params, 'create');
  if (isset($response->returncode) && $response->returncode == 'SUCCESS') {
    unset($response->returncode);
    return $response;
  }
  else {
    return FALSE;
  }
}