k'/.

BigBlueButton API

BigBlueButton is an open-source web conferencing system for online learning. BigBlueButton's simple API gives you an easy HTTP interface for creating, joining, and ending meetings, as well as management of recordings. For popular LMS (Learning Management System) like Moodle, Canvas, Chamilo, they already have plugin. Users can just input the Host Url and Salt Key then can use it and no need for any further coding. For your own developed LMS or any other content management and/or software application, integration is possible using a library available for various programming languages. Below are a few BigBlueButton API documentation and libraries for you as a reference while you are working on the development.

Overview

The BigBlueButton API enables developers to integrate meeting functionality directly into their own applications and services.

Using the API, developers can:

  • Create meetings
  • Join meetings
  • End meetings
  • Retrieve and manage recordings
  • Delete recordings
  • Upload closed caption files

The official API documentation provides complete details for all available endpoints and parameters.

Official BigBlueButton API documentation:

View API Documentation

PHP API Libraries

Several PHP libraries are available to simplify integration with the BigBlueButton API.

Official PHP Library

The official BigBlueButton PHP library provides a simple and well-documented interface for interacting with the API.

The project wiki contains installation instructions, examples, and usage documentation.

  • Complete installation guide
  • Usage examples
  • API documentation
  • Community support and issue tracking

Alternative PHP Library

An unofficial PHP library is also available that provides additional convenience features and a simplified implementation.

.NET API Libraries

Developers building .NET applications can use the following community-supported libraries.

.NET REST Client

A .NET client library for interacting with the BigBlueButton REST API.

Legacy CodePlex Library

Features include:

  • .NET APIs for integrating with BigBlueButton
  • C# helper classes
  • DataTable-based responses for easier development workflows

Java API Library

The official Java API library provides Java developers with a convenient way to integrate BigBlueButton into their applications.

Lombok Requirement

This project uses Lombok and requires it to be installed within your development environment.

  1. Download Lombok from the official website.
  2. Run the Lombok installer using the downloaded JAR file.
  3. Select your IDE installation directory when prompted.
  4. Complete the installation.
  5. Restart your IDE.
  6. Add the Lombok JAR to your project's dependencies.

JavaScript API Library

The JavaScript API library generates BigBlueButton API URLs and can be used in both browser-based applications and Node.js environments.

Ruby API Library

This Ruby gem provides an object-oriented interface for interacting with the BigBlueButton API.

Features include:

  • Simple API method calls
  • Ruby-friendly response formatting
  • Helper classes for advanced operations
  • Presentation upload support

Big Blue Meeting API Information

If you are integrating directly with the Big Blue Meeting service, API connection details can be found within your account dashboard.

Host: manager.bigbluemeeting.com

API Endpoint: /bigbluebutton/api

Shared Secret: Available from your Big Blue Meeting user panel.

BigBlueButton API Information
(the API information panel within Big Blue Manager.)

Sample API URL

The following example demonstrates a typical BigBlueButton API join request:

https://manager.bigbluemeeting.com/bigbluebutton/api/join?fullName=John+Smith&meetingID=jkJKLJ90u&password=my-pass&userID=22&checksum=jefoijpeoj35epoeupou53553