How to configure reservation rest API

huudoanh · October 10, 2018, 7:07am

Hi,
How to configure reservation rest API
I added org.jitsi.impl.reservation.rest.BASE_URL=http://reservation.domain.com to jicofo/sip-communicator.properties, but now I don’t know to which port should I send the HTTP request.
It seems not worked.
Please help me to guide this config.
Thanks,

Quang-Vu_Duong · October 10, 2018, 8:17am

I have the same question.

damencho · October 14, 2018, 11:48pm

github.com

jitsi/jicofo/blob/master/doc/reservation.md

### Support for a reservation system over REST API

It is possible to connect Jicofo to external conference reservation system using
REST API. Before new Jitsi-meet conference is created reservation system will be
queried for room availability. The system is supposed to return positive or
negative response which also contains conference duration. Jicofo will enforce
conference duration and if the time limit is exceeded the conference will be
terminated. If any authentication system is enabled then user's identity will be
included in the reservation system query.

#### Enable reservation system

In order to enable reservation system URL base for REST API endpoint must be
 configured in the following property:

```
org.jitsi.impl.reservation.rest.BASE_URL=http://reservation.example.com
```

It can be either specified with `-Darg=value` when running from the

This file has been truncated. show original

creativeguitar · April 2, 2020, 5:16pm

I am guessing jitsi does not have a reservation system, correct?
Any recommendations for open source reservation system to integrate with jitsi ?

Eyas · April 29, 2020, 9:43pm

have you had any answer dear ?

corby · June 24, 2020, 6:34pm

I have the same question, which has not been answered.

Simply, adding “org.jitsi.impl.reservation.rest.BASE_URL=http://server.domain.com” in “/etc/jitsi/jicofo/sip-communicator.properties” doesn’t seem to be enough.

✓ After restarting, looking at “/var/log/jitsi/jicofo.log”, I can see the message: “org.jitsi.impl.reservation.rest.Activator.log() REST reservation API will use base URL: http://server.domain.com”

✓ Later, when a room is created, the same log shows:
“org.jitsi.impl.reservation.rest.ApiHandler.log() Sending post: {name=test, mail_owner=gh_k6yn14ckug2ei@server.domain.com, start_time=2020-06-24T18:15:02.615Z, duration=-1}”.

⨉ Followed by “org.jitsi.impl.reservation.rest.RESTReservations.log() Unexpected character (<) at position 0.”

？So the question asked remains. The reservation.md file is not complete. Specially, what port is the reservation system listening on? Are there there other steps?

corby · July 15, 2020, 10:36am

More help here: Jocofo Reservation rest API error

pratik · August 22, 2020, 10:31pm

So any idea how to configure reservation and how to use it?

corby · August 23, 2020, 12:03am

I never implemented this, but my understanding is:

Step 1 - develop (code) a reservation system according to the specifications provided

Step 2 - set the org.jitsi.impl.reservation.rest.BASE_URL that points to the system in step 1

Step 3 - enjoy

jbrooks · November 26, 2020, 4:26am

looks like the reservation system has been removed from jicofo. @damencho wrote this can be done in a prosody module. Does anyone know which module? I wasn’t able to find it.

pugelarouge · July 8, 2021, 2:18pm

Hello…

it has been removed from jicofo and re-implemented as a prosody plugin (lua module)

for the prosody plugin see this : Reservation System setup · Jitsi Meet Handbook

if you have an old system / fork and want to see the original jicofo code you can find the old MD here : jicofo/reservation.md at 84952772f72d8a3fecc68f6ec8c1a91e6040b866 · jitsi/jicofo · GitHub

I am using it with secure domain - however am finding that I get the generic “oops, something went wrong and we couldn’t connect to the conference: connection.GET_SESSION_ID_ERROR” error message rather than the message i specify in the error json when sending back a 403 … strangely if my session has held a successful auth from previous connection I do get the custom error message via an orange warning notification.

there is a stale bug for this in github ( Rest Reservation API return Code not being handled properly · Issue #6709 · jitsi/jitsi-meet · GitHub ) going back to the jicofo implementation - I need to test it on a vanilla install + secure domain on the prosody version

pugelarouge · July 8, 2021, 4:48pm

Having now tested the reservation module on a vanilla jitsi-meet install ( jitsi-meet 2.0.5963-1, jicofo 1.0-756-1 , jitsi-videobridge2 2.1-508-gb24f756c-1 , prosody 1.0.5056-1 ) I have the following findings…

Using no / anonymous auth the plugin is working and giving nice orange failure messages when expected.

However when using xmpp auth (secure domain) the auth dialogue just hangs on ‘Obtaining session-id…’ when I return a failure (403 + message) from my reservation API.

I want to use this to lock specific authenticated users ( reservationAPI:mail_owner ) to specific rooms ( reservationAPI:name ) and either way need to continue to use secure domain.
While this does functionally achieve that - it would be better for the end user to actually be told the reason their auth is failing rather than just hanging.

I guess it’s just a case of the auth dialogue not handling the reservation system failure - as I can see the custom message coming back in the IQ / bosh reply to the client / browser.

any pointers welcome ( @damencho / @Pawel_Domas )