API for creating BO-rooms

193 views
Skip to first unread message

Ferdinand Soethe

unread,
Jan 14, 2021, 3:35:12 PM1/14/21
to bigblueb...@googlegroups.com
I want to try and write a client for creating BO-Rooms automatically.
Is there an API I can use and which Windows-Software would you recommend
to access that API?

Kind regards
Ferdinand

Martin Thomas Schrott

unread,
Jan 19, 2021, 1:26:39 AM1/19/21
to bigblueb...@googlegroups.com, Ferdinand Soethe
Hi,


breakout rooms are created as any other meeting, just with additional
flags. Just have a look at the bbb api documentation.

You can use the editor of your choice - this will depend on which
language you want to use.

cheers

Martin

Fred Dixon

unread,
Jan 19, 2021, 6:16:24 AM1/19/21
to BigBlueButton-dev
> I want to try and write a client for creating BO-Rooms automatically.
> Is there an API I can use and which Windows-Software would you recommend to access that API?

Are you looking to create a separate client that can create and manage breakout rooms for a live session?  If you are doing this live, you can log into the session as a moderator and use the BigBlueButton client to create breakout rooms for the presenter?

If you want a server application to trigger the creation of breakout rooms for a live meeting, that would require extending the BigBlueButton API with a new API call to pass the parameters you see in the Breakout Room dialog.  Not a trivial amount of work.


> breakout rooms are created as any other meeting, just with additional flags. Just have a look at the bbb api documentation.
> You can use the editor of your choice - this will depend on which language you want to use.

These suggestions are too high level and they give a false sense that the solution is somehow just look at the docs and create something with an editor of choice (it's like asking someone who wants to build a house to just look at the house next door and use the hammer of your choice).

Regards,... Fred


--
You received this message because you are subscribed to the Google Groups "BigBlueButton-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to bigbluebutton-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/bigbluebutton-dev/66508acd-cdd9-c61c-1443-d64c5d59e2a8%40mtsonline.at.


--
BigBlueButton Developer

Like BigBlueButton?  Tweet us at @bigbluebutton

Martin Thomas Schrott

unread,
Jan 19, 2021, 6:54:32 AM1/19/21
to bigblueb...@googlegroups.com, Fred Dixon

> These suggestions are too high level and they give a false sense that
> the solution is somehow just look at the docs and create something
> with an editor of choice (it's like asking someone who wants to build
> a house to just look at the house next door and use the hammer of your
> choice).
>

:-D okay - thought someone asking such a question could be expected to
be a experienced developer and just was not sure if a special tool was
needed. ;-)

I like the example :-)


cheers

Martin


ma...@soethe.net

unread,
Jan 19, 2021, 7:09:11 PM1/19/21
to BigBlueButton-dev
If I had a hammer ... :-)
Thanks guys!
I once used to be a developer but these skill age more quickly than myself ...

And yet there is still this requirement for creating a predefined set of breakout-rooms at the push of a button.
And since implementing my prev proposal (to create that from an xml document when the conf startet) seems a major task and far away from implementation, I figured that writing a little API script or macro to be triggered at runtime of the conference might help us just a little bit.
Let me know if this is a stupid idea :-)
thx,
ferdinand

Bernhard Fröhlich

unread,
Mar 1, 2021, 12:24:15 PM3/1/21
to BigBlueButton-dev
Please allow me to pick up this thread, since I just ran into very similar requirements.

I already managed to create breakout rooms (with API Mate), so they show up in the parent sessions in the <breakoutRooms> section of the getMeetings result of the parent room. It took me some time to find out that parentMeetingID seems to expect the internal meeting id of the parent, not the creator provided id... So much for RTFM... :-)

I did not yet manage to join the breakout rooms with a join link, but I'm still suspecting myself to be the root cause here... Or is it naive to expect that a breakout room can be entered using a join link? Maybe the user id has to be present in the parent session? BTW, is there documenation on how breakout rooms are expected to work?

Nevertheless, I'd prefer to create the rooms using the API, and then allow the moderator in the parent session to distribute the participants to the API created rooms. Would it be possible that, if there are API created breakout rooms for the current session, the moderator UI just shows the same interface as when rooms have already been created using the UI?

Kind regards
Ted

P.S.: What would be the process if I'd like to extend/correct the doc? I didn't find it on github yet...

sd...@distancelearning.cloud

unread,
Mar 1, 2021, 1:17:08 PM3/1/21
to bigblueb...@googlegroups.com

I would,  tail -f /var/log/nginx/bigbluebutton.access.log and actually create some breakout rooms from the htnl5 client… 

 

You should see the exact create commands and params hitting bbb-web and then be able to emulate.

 

Regards,

Stephen

sd...@distancelearning.cloud

unread,
Mar 1, 2021, 2:01:56 PM3/1/21
to bigblueb...@googlegroups.com

http://xxx.xxxx.cloud/GET%20/bigbluebutton/api/join?fullName=ff&isBreakout=true&joinViaHtml5=true&meetingID=a312afee7319b7615173bd3614eec5ae52455696-1614623815012&password=mp&redirect=true&userID=w_izz1usryxskl-1&checksum=aaa97d3170c75bf992de477e536aeb48e5fd8b00bac9a678befcc67097c8d1b9

 

so just took a look…

 

isBreakout=true and then use the userID=w_izz1usryxskl-1

 

so the the -1 is the room, and the userID the internal user id

 

was able to take this link and join into the room with no problems.

 

So you need to know the users internalID from the main room…  to be able to use this join.

Will also need to know the meetingID a312afee7319b7615173bd3614eec5ae52455696-1614623815012

 

Bbb-web – can see the IDs for the created breakout rooms. In bbb-web logs.

2021-03-01T12:36:55.151-06:00 INFO  o.bigbluebutton.api.MeetingService -  --analytics-- data={"duration":15,"sequence":1,"record":false,"logCode":"create_meeting","name":"Demo Meeting (Room - 1)","description":"Create meeting.","meetingId":"ac9865bc9a7f86c7ce86c506bbbdd53068ef5f2d-1614623815012","externalMeetingId":"a312afee7319b7615173bd3614eec5ae52455696-1614623815012","isBreakout":true,"freeJoin":false,"parentMeetingId":"183f0bf3a0982a127bdb8161e0c44eb696b3e75c-1614623769080","webcamsOnlyForModerator":false}

2021-03-01T12:36:55.164-06:00 INFO  o.bigbluebutton.api.MeetingService -  --analytics-- data={"duration":15,"record":false,"logCode":"meeting_started","name":"Demo Meeting (Room - 1)","description":"Meeting has started.","meetingId":"ac9865bc9a7f86c7ce86c506bbbdd53068ef5f2d-1614623815012","externalMeetingId":"a312afee7319b7615173bd3614eec5ae52455696-1614623815012","isBreakout":true,"parentMeetingId":"183f0bf3a0982a127bdb8161e0c44eb696b3e75c-1614623769080"}

 

Like Fred say a little more effort….

 

What’s the use case for creating them outside the main room?

 

Regards,

Stephen

 

 

From: bigblueb...@googlegroups.com <bigblueb...@googlegroups.com> On Behalf Of Bernhard Fröhlich
Sent: Monday, March 1, 2021 12:24 PM
To: BigBlueButton-dev <bigblueb...@googlegroups.com>
Subject: Re: [bigbluebutton-dev] API for creating BO-rooms

 

Please allow me to pick up this thread, since I just ran into very similar requirements.

Bernhard Fröhlich

unread,
Mar 1, 2021, 4:33:32 PM3/1/21
to bigblueb...@googlegroups.com

Hello Stephen,

the primary goal is to prepare rooms with meaningful names. "Room 1" does not really help to decide which room to pick. Especially when users are allowed to select their own room, but it also helps moderators to put the right people into the right room.

A secondary goal is to simplify logfile analysis by supplying some meta tags.


On 01.03.2021 20:01, sd...@distancelearning.cloud wrote:

http://xxx.xxxx.cloud/GET%20/bigbluebutton/api/join?fullName=ff&isBreakout=true&joinViaHtml5=true&meetingID=a312afee7319b7615173bd3614eec5ae52455696-1614623815012&password=mp&redirect=true&userID=w_izz1usryxskl-1&checksum=aaa97d3170c75bf992de477e536aeb48e5fd8b00bac9a678befcc67097c8d1b9

 

so just took a look…

 

isBreakout=true and then use the userID=w_izz1usryxskl-1

 

so the the -1 is the room, and the userID the internal user id

 

was able to take this link and join into the room with no problems.

 

So you need to know the users internalID from the main room…  to be able to use this join.

Ahh, I see, the correct user id is indeed the trick! And the isBreakout parameter is not yet documented for the join API... I'll give some more tries tomorrow!

Is there some place to write down such things, so the next one with the same problem does not has to bother you? Maybe some extra paragraph about creating BO-rooms in <https://docs.bigbluebutton.org/dev/api.html>? I'd offer to provide text if someone tells me how...

Searching in mail archives is quite cumbersome... :-)

Thanks for you assistance,
Ted


You received this message because you are subscribed to a topic in the Google Groups "BigBlueButton-dev" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/bigbluebutton-dev/mqlDmnnSufs/unsubscribe.
To unsubscribe from this group and all its topics, send an email to bigbluebutton-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/bigbluebutton-dev/005c01d70ecd%2455fce2c0%2401f6a840%24%40distancelearning.cloud.

Александр Скиба

unread,
Aug 25, 2021, 7:52:56 AM8/25/21
to BigBlueButton-dev
So it's somewhat stuck?

вторник, 2 марта 2021 г. в 00:33:32 UTC+3, bern...@cacert.org:

To unsubscribe from this group and stop receiving emails from it, send an email to bigbluebutton-dev+unsubscribe@googlegroups.com.

--
You received this message because you are subscribed to a topic in the Google Groups "BigBlueButton-dev" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/bigbluebutton-dev/mqlDmnnSufs/unsubscribe.
To unsubscribe from this group and all its topics, send an email to bigbluebutton-dev+unsubscribe@googlegroups.com.

Fred Dixon

unread,
Aug 25, 2021, 7:57:34 AM8/25/21
to BigBlueButton-dev
In the upcoming version of BigBlueButton 2.4, the moderator will be able to change the names of breakout rooms.

You can try this on 


image.png

Regards,... Fred

--
You received this message because you are subscribed to a topic in the Google Groups "BigBlueButton-dev" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/bigbluebutton-dev/mqlDmnnSufs/unsubscribe.
To unsubscribe from this group and all its topics, send an email to bigbluebutton-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/bigbluebutton-dev/005c01d70ecd%2455fce2c0%2401f6a840%24%40distancelearning.cloud.

--
You received this message because you are subscribed to the Google Groups "BigBlueButton-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to bigbluebutton-...@googlegroups.com.

Александр Скиба

unread,
Aug 28, 2021, 4:21:13 AM8/28/21
to bigblueb...@googlegroups.com
Thanks, Fred
Are you going to make available ability to force moving users to BO-Rooms?
If not, could you tell how I can make it and what I should use for that?

ср, 25 авг. 2021 г. в 14:57, Fred Dixon <ffd...@gmail.com>:
Reply all
Reply to author
Forward
0 new messages