mconf / bigbluebutton-api-ruby

BigBlueButton API gem for Ruby
Other
49 stars 42 forks source link

GEMAPIRUBY-4 Add 'get_all_meetings' method #52

Closed JoaoCarAlmSilva closed 2 years ago

JoaoCarAlmSilva commented 2 years ago

Adds the get_all_meetings API call, which accepts a hash of options. Without additional parameters, it returns the same as get_meetings.

Important: This is currently not part of the official BigBlueButton API.

Its main purpose is to allow custom APIs to implement additional parameters (e.g. to append the recordings associated with the meetings in the response) keeping the original get_meetings call untouched.

Some parameters implemented on our extension of the API:

Method signature: get_all_meetings(options={})

Usage example:

get_all_meetings()
Response:
{
  :returncode => true,
  :meetings => [
    { :meetingID => "e66e88a3",
    :meetingName => "e66e88a3",
    :createTime => 1389466124414,
    ...
    },
    { :meetingID => "e66e88a4",
    :meetingName => "e66e88a4",
    :createTime => 1389466124999,
    ...
    }
  ],
  :messageKey => "",
  :message => ""
}