You are here

Home » API reference » BigBlueButton 6 » api-0.7.bbb.inc

function bbb_api_join in BigBlueButton 6

Same name in this branch
  1. 6 includes/api-0.64.bbb.inc \bbb_api_join()
  2. 6 includes/api-0.7.bbb.inc \bbb_api_join()
Same name and namespace in other branches
  1. 7 includes/api.bbb.inc \bbb_api_join()

Join Meeting (join)

Parameters

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

  • fullName: STRING (REQUIRED) The full name that is to be used to identify this user to other conference attendees.
  • meetingID: STRING (REQUIRED) If you specified a meeting ID when calling create, then you can use either the generated meeting token or your specified meeting ID to find meetings. This parameter takes your meeting ID.
  • password: STRING (REQUIRED) The password that this attendee is using. If the moderator password is supplied, he will be given moderator status (and the same for attendee password, etc)
  • userID: STRING An identifier for this user that will help your application to identify which person this is. This user ID will be returned for this user in the getMeetingInfo API call so that you can check
  • webVoiceConf: STRING If you want to pass in a custom voice-extension when a user joins the voice conference using voip. This is useful if you want to collect more info in you Call Detail Records about the user joining the conference. You need to modify your /etc/asterisk/bbb-extensions.conf to handle this new extensions.

Return value

There is no XML response for this call if it is properly formatted. You should simply redirect the user to the call URL, and they will be entered into the meeting. NOTE: there is the possibility that a user is sent to a join URL that is invalid right now. For instance, if the client application forms the URL incorrectly, or sends the user to join a meeting that hasn't been created, then the user will end up seeing the XML that would be returned as an error. We need to figure out a better way of handling this.

See also

http://code.google.com/p/bigbluebutton/wiki/API#Join_Meeting_(join)

1 call to bbb_api_join()
bbb_get_meeting in ./bbb.module
Return a meeting object

File

includes/api-0.7.bbb.inc, line 124
Big Blue Button - Enables universities and colleges to deliver a high-quality learning experience.

Code

function bbb_api_join($params) {
  $query_string = bbb_api_generate_querystring(BBB_API_JOIN, $params);
  return BBB_API_BASE_URL . BBB_API_JOIN . '?' . $query_string;
}