JSON API (deprecated)


ISL Online Conference Proxy implements a JSON based API to access certain functionalities of the products.

Note:  This API is deprecated and pending rewrite to conform to the ISL API policy. Please check for existence and changes of functions of this API on every upgrade.

The methods can be called by initiating a HTTP POST to the address: SERVER_URL/__webapi__

Example: https://server98.islonline.net/__webapi__

The following values must be included in each POST:

 fn        : method name

 lang        : language used

 args        : array of arguments for the method

ISL Confproxy supports the methods to login and logout.


 login to the websession

 input parameters :

 user        : username

 pwd        : password

 output parameters:

 sid : session identifier


 logout from the websession

 input parameters:

 sid        : session identifier

For all calls that require login, the session id value is appended to the method name after a #.

ISL Groop JSON API methods are:



retrieve information about a certain session, or a group of sessions

 in order to use the user_ input parameters, you must be logged in first, and have the confproxy websession token

 input parameters: [at least one of the following is required, but more can be given]

 session_id        : session_code (specify the session code of the session you want informations for)

 session_ids        : same as session_id, but accepts a JS array of session codes to retrieve several sessions

 user_invited        : returns information on all session that the user is invited to [must be logged in]

 user_owned        : returns all sessions that the user owns [must be logged in]

 user_active        : returns all the active session (running at the moment) that the user owns [must be logged in]

 return value :

 sessions : array of session objects



 retrieve the JS code to run the ISL Groop client, either by invoking webstart (if installed) or downloading the .exe file

 required input parameters:

 session_id        : session_code of the session you wish to join

 optional input parameters:

 join_uid                : unique join id, given by the addRegisteredUser funcion

 address                : server address

 additional        : additional network connect information

 port                : server port

 use_http        : use http connection

 use_https        : use https connection

 file_name        : the name of the executable

 custom                : use customization

 return value :

 func : JS function you can call to initiate join


 Create a new ISL Groop meeting or webinar. You must login first and have the required ISL Confproxy websession id.

 required input parameters :

 session_name        : title of the session

 optional input parameters :

 session_type        : {meeting(default) | webinar}

 auth_type          : {public(default) | public_and_reg | reg_only | closed}

 default_role        : {host | presenter(default) | guest}

 start_time          : {starting_time}

 layout              : {presentation | conference}

 return value :

         session_code : the code of the newly created session


 register an "anonymous" user for the session by providing certain information about this user and getting the specific join_uid which then identifies this user when joining the session

 you must be logged in as the owner of the session in order to execute this function

 required input parameters :

 session_id        : session_code

 name                : user_name (nickname)

 optional input parameters:

 email              : email address

 email_notify        : [0(default) | 1] (send email notificiations? .. if this is set, email is required aswell)

 role                : the role of this user in session

 lang                : language

 company            : user's company

 phone              : user's phone number

 return value:

 uid : join_uid that is used to identify this user when joining session


 delete the ISL Groop meeting or webinar

 you must be logged in as the owner of the session in order to execute this function

 required input parameter :

       session_id        : session code of session to delete [required]

 return value: none

Example session:



 'fn' : 'Login.login',

 'lang' : 'en',

 'args' : { 'user' : 'test.user@example.org', 'pwd' : 'testpassword' }


Returns: { 'sid' : 'ABCDEFGH' }



 'fn' : 'ISLGroop.Session.create#ABCDEFGH',

 'lang' : 'en',

 'args' : { session_name : 'test meeting'  }


Returns: { 'session_code' : '123-456-789-012' }

The meeting is now created and can be joined by navigating your browser to:




 'fn' : 'ISLGroop.Session.getInfo#ABCDEFGH',

 'lang' : 'en',

 'args' : { session_id : '123-456-789-012'  }


Returns : { 'sessions' : [{ 'active' : 0, 'session_code' :  '123-456-789-012', 'session_name' :  'test meeting'}]}



 'fn' : 'Login.logout#ABCDEFGH',

 'lang' : 'en',

 'args' : { }


Was this article helpful?