server api

API Requests consist of JSON encoded data posted to https://yourserver.net/api/

Requests contain, at minimum, serverGuid, apiKey, and command fields:

    {
        "serverGuid" : "YourServerId",
        "apiKey"     : "YourApiKey",
        "command"    : "FunctionName"
        ((( additional parameters )))
    }

Responses contain a success field, with a 1 or a 0 indicating the result of the operation, a command field containing the function name that was executed, an error field detailing any problem encountered, as well as data resulting from the operation.

    {
        "success"   : 1,
        "command"   : "FunctionName"
        "error"     : "error information, if needed"
        ((( result data )))
    }

Available commands are detailed below. As noted previously, all commands require serverGuid, apiKey, and command fields. REQUIRED and OPTIONAL parameters are listed below each command.

Room Management APIs

Manage conference rooms within a server. In most cases, server administrators will want to manage rooms using the server control panel.

createroom
Add a new conference room to the server, and returns the room configuration. The returned room contains the newly assigned uuid which must be used in all api calls pertaining to the new room.
rname The Room Name as it appears in the hash tag:
https://yourserver.net/#ServerName/RoomName
The room name must be unique within your server, and should not contain space, slash, percent or quote characters. string, 32 chars max
ownerEmail Email address of the room owner. Anyone logging in with this email address will do so as the room owner, regardless of account settings associated with the email through other means.
seats number of seats (simultaneous users) for the room, positive integer
...additional parameters as detailed in updateroom
updateroom
Modify the configuration of a conference room, and return the room configuration. Thus, to retrieve the current room configuration, call updateroom without any of the optional parameters.
uuid room unique id, string
rname The Room Name as it appears in the hash tag:
https://yourserver.net/#ServerName/RoomName
The room name must be unique within your server, and should not contain space, slash, percent or quote characters. string, 32 chars max
ownerEmail Email address of the room owner. Anyone logging in with this email address will do so as the room owner, regardless of account settings associated with the email through other means.
seats number of seats (simultaneous users) for the room, positive integer
tsexpire expiration date expressed in seconds since Jan 1, 1970, or zero for no expiration. non-negative integer
enabled room enabled or disabled, integer.
  1. room disabled
  2. room enabled (default)
numMics number of concurrent speakers, integer
  1. single microphone (default)
  2. dual microphones. two users may speak at once.
video webcam video enabled / video mode, integer.
  1. do not display webcam video (default)
  2. 160x120 video window
  3. 320x240 video window
whiteboard whiteboard feature enabled, integer.
  1. whitboard not shown
  2. whiteboard enabled (default)
registration control whether registration is required, integer.
  1. anonymous login allowed. (default)
  2. email registration required
guestLogins control how guest logins are treated, integer.
  1. allow guests to enter (default)
  2. moderate guest logins
  3. reject guest logins
textModeration public text chat moderation, integer.
  1. do not moderate (default)
  2. moderate guests
  3. moderate members and guests
textMute control text message muting, integer.
  1. not muted (default)
  2. guests are text muted
  3. members and guests are text muted
  4. automatic mute (members) when no moderator present
audioMute control audio muting, integer.
  1. not muted (default)
  2. guests are audio muted
  3. members and guests are audio muted
  4. automatic mute (members) when no moderator present
textLog number of recent messages to store in the text log, integer, 0-500
lockRoom the lock state of the room, integer.
  1. room is unlocked (default)
  2. room is locked
  3. room locked if no moderator present
privateText control who may send private text messages, integer.
  1. everyone (default)
  2. members and above
  3. presenters and above
onlineNow show "online now" section on login page, integer.
  1. disabled - do not show
  2. enabled - show online now (default)
geoLoc show user location, integer.
  1. disabled - do not show location
  2. enabled - show location (default)
title title of the html page, displayed in the browser tab, string, 64 chars max
prompt text of the sign in button, 64 chars max. Prompt only applies when
header html displayed above the login form, 4000 chars max
footer html displayed below the login form, 4000 chars max
color background color of the login page, 7 chars, #rrggbb
deleteroom
Delete a conference room
uuid room unique id, string
getrooms
Return a list of all conference rooms including all configuration parameters.

User Management APIs

Manage users within a room. In most cases, these APIs are not needed since creation of user accounts is automatic when a user registers and enters a room for the first time. Do not use these APIs if you are using delegated authentication.

updateuser
Modify the configuration of a room user, and return the user configuration, creating the user if it did not previously exist. Calling updateuser without any optional parameterss retrieves the current configuration.
uuid room unique id, string
email user email address, string
role the privilege level for this user, integer.
  1. blocked (email address is black-listed)
  2. guest
  3. member (default)
  4. presenter (whiteboard access)
  5. moderator (mute, boot and ban)
  6. administrator (control panel access)
uname Display name for the user. Reserves the name for this user, and overrides the name entered on the login form. Pass null to allow the user to select their own name at login. string, 1-30 chars. default null.
color display color of user name, 7 chars, #rrggbb. pass null to use the default color for verified users.
tsexpire expiration date expressed in seconds since Jan 1, 1970, or zero for no expiration. non-negative integer
deleteuser
Delete the user account. If the account was blocked, then deleting the account will unban the email address.
uuid room unique id, string
email user email address, string
getusers
Retrieve a list of users configured in the conference room.
uuid room unique id, string

Data Retrieval APIs

Get login history, etc.

history
Retrieve the login history for the room or server.
uuid room unique id, or absent for entire server, string
start index of first result, default 0 (the most recent login), integer
max maximum number of results, 10-1000, default 100, integer