API::BigBlueButton::Requests - processing of API requests
version 0.013
Getting the current version of the BigBlueButton
Create a meeting
%params:
name
This parameter is optional. A name for the meeting.
meetingID
This parameter is mandatory. A meeting ID that can be used to identify this meeting by the third party application.
attendeePW
This parameter is optional.
moderatorPW
welcome
dialNumber
voiceBridge
webVoice
logoutURL
record
duration
meta
redirectClient
clientURL
SEE MORE https://code.google.com/p/bigbluebutton/wiki/API#create
Joins a user to the meeting specified in the meetingID parameter.
fullName
This parameter is mandatory. The full name that is to be used to identify this user to other conference attendees.
This parameter is mandatory. The meeting ID that identifies the meeting you are attempting to join.
password
This parameter is mandatory. 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)
createTime
userID
webVoiceConf
configToken
avatarURL
SEE MORE https://code.google.com/p/bigbluebutton/wiki/API#join
This call enables you to simply check on whether or not a meeting is running by looking it up with your meeting ID.
This parameter is mandatory. The meeting ID that identifies the meeting you are attempting to check on.
Use this to forcibly end a meeting and kick all participants out of the meeting.
This parameter is mandatory. The meeting ID that identifies the meeting you are attempting to end.
This parameter is mandatory. The moderator password for this meeting. You can not end a meeting using the attendee password.
This call will return all of a meeting's information, including the list of attendees as well as start and end times.
This parameter is mandatory. The moderator password for this meeting. You can not get the meeting information using the attendee password.
This call will return a list of all the meetings found on this server.
Retrieves the recordings that are available for playback for a given meetingID (or set of meeting IDs).
Publish and unpublish recordings for a given recordID (or set of record IDs).
recordID
This parameter is mandatory. A record ID for specify the recordings to apply the publish action. It can be a set of record IDs separated by commas.
publish
This parameter is mandatory. The value for publish or unpublish the recording(s). Available values: true or false.
Delete one or more recordings for a given recordID (or set of record IDs).
This parameter is mandatory. A record ID for specify the recordings to delete. It can be a set of record IDs separated by commas.
Retrieve the default config.xml.
SEE MORE https://code.google.com/p/bigbluebutton/wiki/API#getDefaultConfigXML
Associate an custom config.xml file with the current session.
This parameter is mandatory. A meetingID to an active meeting.
configXML
This parameter is mandatory. A valid config.xml file
SEE MORE https://code.google.com/p/bigbluebutton/wiki/API#setConfigXML
Create a checksum for the query
$request
Name of query, e.g. 'create' or 'join'
$params:
Query parameters my $chksum = $self->generate_checksum( 'create', \%params );
Creating a query string
Query parameters $params{checksum} = $self->generate_checksum( 'create', \%params ); $params{request} = 'create'; my $url = $self->generate_url_query( \%params );
API::BigBlueButton
API::BigBlueButton::Response
BigBlueButton API
Alexander Ruzhnikov <a.ruzhnikov@reg.ru>
To install API::BigBlueButton, copy and paste the appropriate command in to your terminal.
cpanm
cpanm API::BigBlueButton
CPAN shell
perl -MCPAN -e shell install API::BigBlueButton
For more information on module installation, please visit the detailed CPAN module installation guide.