omNovia Rooms API Documentation

General information and base sample code

Each of the API calls described below are able to be made via URL (GET) or CURL (POST).

$cID = 1234;          //Provided by omNovia support
$cPW = 'password';    //Provided by omNovia support

$params = array('cID' => $cID,
                'cPW' => $cPW,
                .
                .
                .
                );
$url = "http://www.omnovia.com/support/apis/rooms.php";

function callRemote($url, $params, $returnResponse = true)
{
    $c = curl_init($url);

    curl_setopt($c, CURLOPT_POST, true);
    curl_setopt($c, CURLOPT_POSTFIELDS, $params);
    curl_setopt($c, CURLOPT_HEADER, false);
    curl_setopt($c, CURLOPT_RETURNTRANSFER, $returnResponse);

    $response = curl_exec($c);
    curl_close($c);
    
    if ($returnResponse)
        return $response;
}

This method allows you to see the list of rooms for a given company.

http://www.omnovia.com/support/apis/rooms.php?action=getroomlist&cID=1234&cPW=password

GET or POST Parameters:
Required:
(int) cID (company ID)
(str) cPW (company password)

<root>
   <room>
      <roomID><![CDATA[1234]]></roomID>
      <name><![CDATA[room1]]></name>
   </room>
</root>

This method allows you to retrieve the guest password for a given room.

http://www.omnovia.com/support/apis/rooms.php?action=readGuestPassword&cID=1234&cPW=password&rID=5678

GET or POST Parameters:
Required:
(int) cID (company ID)
(str) cPW (company password)
(int) rID (room ID)

    

<root>
   <roomPassword>
      <password><![CDATA[password1]]></password>
   </roomPassword>
</root>

This allows you to change the guest password for a given room.

http://www.omnovia.com/support/apis/rooms.php?action=updateguestpassword&cID=1234&cPW=password&rID=1234
&rPW=thenewpassword

GET or POST Parameters:
Required:
(int) cID (company ID)
(str) cPW (company password)
(int) rID (room ID)
(str) rPW (room password)

    

<root>
 <status><![CDATA[Success]]></status>
</root>

This allows you to change the guest password for a given room.

http://www.omnovia.com/support/apis/rooms.php?action=updateroomproperties&cID=1234&cPW=password&rID=1234& ... 
(see list of parameters below)

GET or POST Parameters:
Required:
(int) cID (company ID)
(str) cPW (company password)
(int) rID (room ID)

Optional:
(str) name
(str) shorturl        (room's shorturl -- must be unique to the shorturls of other rooms for your company)
(str) password
(str) announcement
(0,1) askPhone
(0,1) twoWindows
(0-2) appShare              (0 = off; 1 = on left; 2 = on right)
(0-2) slideShow             (0 = off; 1 = on left; 2 = on right)
(0-2) whiteBoard            (0 = off; 1 = on left; 2 = on right)
(0-2) coBrowser             (0 = off; 1 = on left; 2 = on right)
(0-2) moviePlayer           (0 = off; 1 = on left; 2 = on right)
(0-2) liveVideo             (0 = off; 1 = on left; 2 = on right)
(0-2) notes                 (0 = off; 1 = on left; 2 = on right)
(0,1) lockTabs
(0,1) sharedFolderTab
(0,1) twitterTab
(0,1) isDefaultPrivatized
(0-3) usersPMPreference     (0 = none; 1 = to mods; 2 = to attendees; 3 = to all)
(0-2) announcementMode      (0 = announcements off; 1 = normal display; 2 = side by side)
(0,1) audioAnnouncement     (Audio Notifications - Announcement)
(0,1) audioSurvey           (Audio Notifications - Instant Poll)
(0,1) audioChat             (Audio Notifications - Any New Chat Message)
(0,1) audioPM               (Audio Notifications - Private Messaging)
(0,1) audioOperChat         (Audio Notifications - Presenter / Mod Chat Message)
(0,1) audioEnterNotice      (Audio Notifications - Entrance Notices)
(0,1) audioOnProjection     (Audio Notifications - Projection Start)
(0,1) noSelectText
(int) closeRoomAfter
(0,1) showNbUsersToAll
(0,1) usersListPreference
(0,1) showOnlyFirstName
(str) timeZoneName          (Click to see values)
(0,1) useAMPM
(0-3) showTopBanner         (0 = dont show banner; 1 = left justified; 2 = centered; 3 = right justified)    
(int) roomWidth
(int) roomHeight
(0,1) roomResizable
(0,1) lockCollapse
(1,2,3,5) chatPosition      (1 = under list; 2 = Left; 3 = Right; 5 = Extended)
(str) customChatName        (entering a name enables the Alt Chat Tab. Start the string with !! for mods only)
(0,1) history
(str) welcomeMsg
(str) eCurtainText
(str) marketingURL
(str) endMarketingURL
(num) skin_id (1=gray(default), 2=blue, 3=orange, 4=gray and red, 6=black, 7=white and green,
109=blue and white, 132=pink, 133=azure)

POST Parameters ONLY:
Optional:
(bin) topBanner
(bin) marketingImage

    

<root>
 <param><![CDATA[name = my room2]]></param>
 <param><![CDATA[shorturl = room2]]></param>
 <param><![CDATA[slideShow = 2]]></param>
 <param><![CDATA[appShare = 1]]></param>
 .
 .
 .
</root>

This allows you to change the guest password for a given room.

http://www.omnovia.com/support/apis/rooms.php?action=createnewroom&cID=1234&cPW=password& ... 
(see list of parameters in Update Room Settings)

GET or POST Parameters:
Required:
(str) cID (company ID)
(str) cPW (company password)
(str) name        (room name)
(str) shorturl    (room's shorturl -- must be unique to the shorturls of other rooms for your company)


Optional:
(see list of parameters in Update Room Settings)
 

<root>
 <param><![CDATA[new room ID = 28924]]></param>
 <param><![CDATA[name = my room2]]></param>
 <param><![CDATA[shorturl = room2]]></param>
 <param><![CDATA[slideShow = 2]]></param>
 <param><![CDATA[appShare = 1]]></param>
 .
 .
 .
</root>