How to create a new conference using SOAP API in the openmeeting

December 07, 2016 - 13:09

OpenMeeting is an open source and independent alternative for Google Hangouts. It allows video/audio conference, collaborative editing, screen sharing, instant messaging etc. OpenMeeting community provides plugins for integrating to common platforms like moodle, Sakai, Jira, Joomla, Bitrix, Confluence, SugraCRM, Redmine. Unfortunately, the Drupal plugin for openmeeting is not opensource.

A good news is, OpenMeeting provides a SOAP API for integrating OpenMeeting with other platforms.

I will explain how to create a new conference via OpenMeeting's SOAP API.

First, the user need to retrieve session ID for doing particular actions to be done using SOAP API.

This can be retrieved by making a call to
http://[host]:[port]/openmeetings/services/UserService/getSession

Return will be an XML. We need to parse session ID from the XML.

Then login using admin credential. For that, we can make call to

http://localhost:5080/openmeetings/services/UserService/loginUser?SID=VALUE&username=VALUE&userpass=VALUE

SID is the value we retrieved in the first request.

To create a new conference, we can make use of the API gateway method addRoomWithModerationQuestionsAndAudioType.

For example,


http://localhost:5080/openmeetings/services/RoomService/addRoomWithModerationQuestionsAndAudioType?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&appointment=VALUE&isDemoRoom=VALUE&demoTime=VALUE&isModeratedRoom=VALUE&allowUserQuestions=VALUE&isAudioOnly=VALUE

SID = The SID of the User. This SID must be marked as Loggedin
name = Name of the Room
roomtypes_id = Type of that room (1 = Conference, 2 = Audience, 3 = Restricted, 4 = Interview)
comment = any comment
numberOfPartizipants = the maximum users allowed in this room
ispublic = If this room is public (use true if you don't deal with different Organizations) [boolean]
appointment = is it a Calendar Room (use false by default)
isDemoRoom = is it a Demo Room with limited time (use false by default)
demoTime = time in seconds after the user will be logged out (only enabled if isDemoRoom is true)
isModeratedRoom = Users have to wait until a Moderator arrives. Use the becomeModerator param in setUserObjectAndGenerateRoomHash to set a user as default Moderator
allowUserQuestions = enable or disable the button to allow users to apply for moderation
isAudioOnly = enable or disable the video / or audio-only

Detailed documentation is given in the link: http://openmeetings.apache.org/openmeetings-webservice/apidocs/index.html

Hope this helps. Please feel free to get in touch with us if you have any further queries.

Get Drupal updates straight to your inbox

To prevent automated spam submissions leave this field empty.

Post your comments / questions