Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 1.22 KB

rest-muc-client.md

File metadata and controls

28 lines (24 loc) · 1.22 KB
Raw

The configuration for the XMPP client connections that jitsi-videobridge uses can be modified at run time using REST calls to /colibri/muc-client/.

Adding an XMPP client connection

A new XMPP client connection (i.e. a MucClient) can be added by posting a JSON which contains its configuration to /colibri/muc-client/add:

{
  "id": "new-client-connection",
  "domain":"xmpp.example.com",
  "hostname":"10.0.0.1",
  "username":"xmpp-username",
  "password":"xmpp-password",
  "muc_jids":"JvbBrewery@conference.xmpp.example.com",
  "muc_nickname":"unique-resource",
  "disable_certificate_verification":"false"
}

If a configuration with the specified ID already exists, the request will succeed (return 200), but the configuration will NOT be updated. If you need to update an existing configuration, you need to remove it first and then re-add it.

Removing an XMPP client connection.

An XMPP client connection (i.e. a MucClient) can be removed by posting a JSON which contains its ID to /colibri/muc-client/remove:

{
  "id": "new-client-connection"
}

The request will be successful (return 200) as long as the format of the JSON is as expected, regardless of whether a connection was found and removed or it wasn't found.