NAME

API::BigBlueButton::Requests - processing of API requests

VERSION

version 0.015

METHODS

get_version($self)

Getting the current version of the BigBlueButton

create($self,%params)

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

This parameter is optional.

welcome

This parameter is optional.

dialNumber

This parameter is optional.

voiceBridge

This parameter is optional.

webVoice

This parameter is optional.

logoutURL

This parameter is optional.

record

This parameter is optional.

duration

This parameter is optional.

meta

This parameter is optional.

redirectClient

This parameter is optional.

clientURL

This parameter is optional.

SEE MORE https://code.google.com/p/bigbluebutton/wiki/API#create

join($self,%params)

Joins a user to the meeting specified in the meetingID parameter.

%params:

fullName

This parameter is mandatory.
The full name that is to be used to identify this user to other conference attendees.

meetingID

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

This parameter is optional.

userID

This parameter is optional.

webVoiceConf

This parameter is optional.

configToken

This parameter is optional.

avatarURL

This parameter is optional.

redirectClient

This parameter is optional.

clientURL

This parameter is optional.

SEE MORE https://code.google.com/p/bigbluebutton/wiki/API#join

ismeetingrunning($self,%params)

This call enables you to simply check on whether or not a meeting is running by looking it up with your meeting ID.

%params:

meetingID

This parameter is mandatory.
The meeting ID that identifies the meeting you are attempting to check on.

end($self,%params)

Use this to forcibly end a meeting and kick all participants out of the meeting.

%params:

meetingID

This parameter is mandatory.
The meeting ID that identifies the meeting you are attempting to end.

password

This parameter is mandatory.
The moderator password for this meeting. You can not end a meeting using the attendee password.

getmeetinginfo($self,%params)

This call will return all of a meeting's information, including the list of attendees as well as start and end times.

%params:

meetingID

This parameter is mandatory.
The meeting ID that identifies the meeting you are attempting to check on.

password

This parameter is mandatory.
The moderator password for this meeting.
You can not get the meeting information using the attendee password.

getmeetings($self)

This call will return a list of all the meetings found on this server.

getrecordings($self,%params)

Retrieves the recordings that are available for playback for a given meetingID (or set of meeting IDs).

%params:

meetingID

This parameter is optional.

publishrecordings($self,%params)

Publish and unpublish recordings for a given recordID (or set of record IDs).

%params:

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.

deleterecordings($self,%params)

Delete one or more recordings for a given recordID (or set of record IDs).

%params:

recordID

This parameter is mandatory.
A record ID for specify the recordings to delete.
It can be a set of record IDs separated by commas.

getdefaultconfigxml($self)

Retrieve the default config.xml.

SEE MORE https://code.google.com/p/bigbluebutton/wiki/API#getDefaultConfigXML

setconfigxml($self,%params)

Associate an custom config.xml file with the current session.

%params:

meetingID

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

generate_checksum($self,$request,$params)

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 );

generate_url_query($self,$params)

Creating a query string

$params:

Query parameters

$params{checksum} = $self->generate_checksum( 'create', \%params );
$params{request}  = 'create';
my $url = $self->generate_url_query( \%params );

SEE ALSO

API::BigBlueButton

API::BigBlueButton::Response

BigBlueButton API

AUTHOR

Alexander Ruzhnikov <a.ruzhnikov@reg.ru>