PHPackages yaangvu/bbb-api-php - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. yaangvu/bbb-api-php Abandoned → yaangvu-bbb-api-phpLibrary[API Development](/categories/api) yaangvu/bbb-api-php =================== BigBlueButton PHP API Library for PHP updated by YaangVu 1.0.3(8y ago)1123GNU Lesser General Public LicensePHPPHP >=5.4 Since Oct 18Pushed 8y ago1 watchersCompare [ Source](https://github.com/YaangVu/bbb-api-php)[ Packagist](https://packagist.org/packages/yaangvu/bbb-api-php)[ Docs](http://bigbluebutton.org/)[ RSS](/packages/yaangvu-bbb-api-php/feed)WikiDiscussions master Synced 5d ago READMEChangelogDependencies (6)Versions (5)Used By (0) [![Build Status](https://camo.githubusercontent.com/0da94635638c85d3767b83bf1198eba80da6722c9148f5a7a363a2aa5560fc2a/68747470733a2f2f7472617669732d63692e6f72672f626967626c7565627574746f6e2f626967626c7565627574746f6e2d6170692d7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/bigbluebutton/bigbluebutton-api-php)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/e81a928465582353ac2a8b5ca3b6c7c95d11afedbbf3090a4a7cc05ca7d7491c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f626967626c7565627574746f6e2f626967626c7565627574746f6e2d6170692d7068702f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/bigbluebutton/bigbluebutton-api-php/?branch=master)[![Coverage Status](https://camo.githubusercontent.com/5ce35c2d5c4b2272ca07cc13e79a79adc91484d8a64768647dd26d3c7f58514e/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f626967626c7565627574746f6e2f626967626c7565627574746f6e2d6170692d7068702f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/bigbluebutton/bigbluebutton-api-php?branch=master)[![Downloads](https://camo.githubusercontent.com/f7ebf9c7a3cea4b894877655382b4fe176a0a00dd131c3eeba7e5d68437fd4fe/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f626967626c7565627574746f6e2f626967626c7565627574746f6e2d6170692d7068702e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bigbluebutton/bigbluebutton-api-php)[![@bigbluebutton on Twitter](https://camo.githubusercontent.com/10d10210d96c749bf6a09858fb33fada3607f4ae0456ca148320b5cb8fa9949d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d253430626967626c7565627574746f6e2d626c75652e7376673f7374796c653d666c6174)](https://twitter.com/bigbluebutton) [![PHP 5.4](https://camo.githubusercontent.com/8803a0773b8d2314396d7922be4ed9475bb4cfe61e0395156558c047eb7e256e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d352e342d3838393242462e7376673f7374796c653d666c61742d737175617265)](https://php.net/)[![PHP 5.5](https://camo.githubusercontent.com/126268109b06bc3e1085f341e74e3d6406bc18adbdd48bad6359fff93d190579/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d352e352d3838393242462e7376673f7374796c653d666c61742d737175617265)](https://php.net/)[![PHP 5.6](https://camo.githubusercontent.com/1e72d9121445f411d632f2607a74e0c6f63b4a8900a310c7a1dd5a1ee8b55352/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d352e362d3838393242462e7376673f7374796c653d666c61742d737175617265)](https://php.net/)[![PHP 7](https://camo.githubusercontent.com/939c95529a45a89e9db2058d29fd65219d3d702df7379ba3acfdb303f88b5c06/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d372d3838393242462e7376673f7374796c653d666c61742d737175617265)](https://php.net/)[![PHP 7.1](https://camo.githubusercontent.com/176e5b546146d5be988e1cc83777ae0f846fe56e3093b0c53fa71b9ecba2a421/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d372e312d3838393242462e7376673f7374796c653d666c61742d737175617265)](https://php.net/) BigBlueButton API for PHP ========================= [](#bigbluebutton-api-for-php) The official and easy to use **BigBlueButton API for PHP**, makes easy for developers to use [BigBlueButton](http://bigbluebutton.org) API for **PHP 5.4+**. Requirements ------------ [](#requirements) - PHP 5.4 or above. - Curl library installed. BigBlueButton API for PHP is also tested to work with HHVM and fully compatible with PHP 7.1. Installation ------------ [](#installation) **bigbluebutton-api-php** can be installed via [Composer](https://getcomposer.org) CLI ``` composer require yaangvu/bbb-api-php:1.0.0 ``` or by editing [Composer](https://getcomposer.org).json ``` { "require": { "yaangvu/bbb-api-php": "1.0.0" } } ``` Usage ----- [](#usage) You should have environment variables `BBB_SECURITY_SALT` and `BBB_SERVER_BASE_URL` defined in your sever. \*if you are using Laravel you can add it in your .env The you will be able to call BigBlueButton API of your server. A simple usage example for create meeting looks like: ``` use BigBlueButton/BigBlueButton; $bbb = new BigBlueButton(); $createMeetingParams = new CreateMeetingParameters('bbb-meeting-uid-65', 'BigBlueButton API Meeting'); $response = $bbb->createMeeting($createMeetingParams); echo "Created Meeting with ID: " . $response->getMeetingId(); ``` Example ------- [](#example) ### \# Get meetings [](#-get-meetings) ``` use BigBlueButton\BigBlueButton; $bbb = new BigBlueButton(); $response = $bbb->getMeetings(); if ($response->getReturnCode() == 'SUCCESS') { foreach ($response->getRawXml()->meetings->meeting as $meeting) { // process all meeting } } ``` ### \# Create Meeting [](#-create-meeting) ``` use BigBlueButton\BigBlueButton; use BigBlueButton\Parameters\CreateMeetingParameters; $bbb = new BigBlueButton(); $createMeetingParams = new CreateMeetingParameters($meetingID, $meetingName); $createMeetingParams->setAttendeePassword($attendee_password); $createMeetingParams->setModeratorPassword($moderator_password); $createMeetingParams->setDuration($duration); $createMeetingParams->setLogoutUrl($urlLogout); if ($isRecordingTrue) { $createMeetingParams->setRecord(true); $createMeetingParams->setAllowStartStopRecording(true); $createMeetingParams->setAutoStartRecording(true); } $response = $bbb->createMeeting($createMeetingParams); if ($response->getReturnCode() == 'FAILED') { return 'Can\'t create room! please contact our administrator.'; } else { // process after room created } ``` ### \# Join Meeting [](#-join-meeting) ``` use BigBlueButton\BigBlueButton; use BigBlueButton\Parameters\JoinMeetingParameters; $bbb = new BigBlueButton(); $joinMeetingParams = new JoinMeetingParameters($meetingID, $name, $password); // $moderator_password for moderator $joinMeetingParams->setRedirect(true); $url = $bbb->getJoinMeetingURL($joinMeetingParams); // header('Location:' . $url); ``` ### \# Close Meeting [](#-close-meeting) ``` use BigBlueButton\BigBlueButton; use BigBlueButton\Parameters\EndMeetingParameters; $bbb = new BigBlueButton(); $endMeetingParams = new EndMeetingParameters($meetingID, $moderator_password); $response = $bbb->endMeeting($endMeetingParams); ``` ### \# Get Meeting Info [](#-get-meeting-info) ``` use BigBlueButton\BigBlueButton; use BigBlueButton\Parameters\GetMeetingInfoParameters; $bbb = new BigBlueButton(); $getMeetingInfoParams = new GetMeetingInfoParameters($meetingID, '', $moderator_password); $response = $bbb->getMeetingInfo($getMeetingInfoParams); if ($response->getReturnCode() == 'FAILED') { // meeting not found or already closed } else { // process $response->getRawXml(); } ``` ### \# Get Recordings [](#-get-recordings) ``` use BigBlueButton\BigBlueButton; use BigBlueButton\Parameters\GetRecordingsParameters; $recordingParams = new GetRecordingsParameters(); $bbb = new BigBlueButton(); $response = $bbb->getRecordings($recordingParams); if ($response->getReturnCode() == 'SUCCESS') { foreach ($response->getRawXml()->recordings->recording as $recording) { // process all recording } } ``` *note that BigBlueButton need about several minutes to process recording until it available.* *You can check in* `bbb-record --watch` ### \# Delete Recording [](#-delete-recording) ``` use BigBlueButton\BigBlueButton; use BigBlueButton\Parameters\DeleteRecordingsParameters; $bbb = new BigBlueButton(); $deleteRecordingsParams= new DeleteRecordingsParameters($recordingID); // get from "Get Recordings" $response = $bbb->deleteRecordings($deleteRecordingsParams); if ($response->getReturnCode() == 'SUCCESS') { // recording deleted } else { // something wrong } ``` Submitting bugs and feature requests ------------------------------------ [](#submitting-bugs-and-feature-requests) Bugs and feature request are tracked on [GitHub](https://github.com/bigbluebutton/bigbluebutton-api-php/issues) Contributing guidelines ----------------------- [](#contributing-guidelines) ### Code style [](#code-style) Make sure the code style configuration is applied by running PHPCS-Fixer. ``` ./vendor/bin/php-cs-fixer fix ``` ### Runing tests [](#runing-tests) For every implemented feature add unit tests and check all is green by running the command below. ``` ./vendor/bin/phpunit ``` ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity61 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 4 Last Release 3131d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/fc6edb5366277d97ecfedc77bcfbf41f49be74ccb182f6c2d04e597640d0c15c?d=identicon)[YaangVu](/maintainers/YaangVu) --- Top Contributors [![YaangVu2](https://avatars.githubusercontent.com/u/26708722?v=4)](https://github.com/YaangVu2 "YaangVu2 (3 commits)") --- Tags apibigbluebuttonbbb ### Code Quality TestsPHPUnit Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/yaangvu-bbb-api-php/health.svg) ``` [![Health](https://phpackages.com/badges/yaangvu-bbb-api-php/health.svg)](https://phpackages.com/packages/yaangvu-bbb-api-php) ``` ### Alternatives [bigbluebutton/bigbluebutton-api-php BigBlueButton PHP API Library for PHP 1931.2M12](/packages/bigbluebutton-bigbluebutton-api-php)[joisarjignesh/bigbluebutton BigBlueButton Server API Library for Laravel 162145.5k1](/packages/joisarjignesh-bigbluebutton)[littleredbutton/bigbluebutton-api-php BigBlueButton PHP API Library for PHP 27203.2k1](/packages/littleredbutton-bigbluebutton-api-php)[m165437/laravel-blueprint-docs API Blueprint Renderer for Laravel 22779.0k](/packages/m165437-laravel-blueprint-docs) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)