Room

Multi-user chat rooms or Rooms will include general occupant information along with meta data about that room.

Owner

Owner is the user who first created the room. If the room is user created or if the rooms are not provisioned ahead of time this user will be the first person to have joined a particular room. This ownership provides the user the ability to manage/moderate the room. For publishers who don’t implement moderation controls this is merely a formality.

Administrator

Administrators are users who like owners have the ability to moderate the room and like owners have the ability to create moderators but not other administrators.

Moderator

Moderators are users who can moderate the room but have no ability to promote other users to anything past member.

Member

Members are users who have established an affiliation with the room but dont have any sort of escalated rights within the room.

Visitor

Visitors are users who have no affiliation with the room and no escalated rights at all.

Occupants

Occupants is simply a reference to all users regardless of their role. This is used to represent a count of total users.

JSON Format

All of our APIs respond with a standard response format to provide a basic level of information about the call in addition to the response data.

Name	Type	Read-only	Mandatory	Comment
rooms	Array	true	false	An array of Rooms in the conference

Example

{
  "result": "Success",
  "resultCode": 200,
  "message": "",
  "error": [],
  "data":  {
        "roomId": "roomId|siteId",
        "name": "roomId|siteId",
        "admins": 0,
        "creationDate": "2012-06-25T17:21:33.747Z",
        "description": "Description of Room, defaults to the roomId",
        "maxUsers": 0,
        "members": 0,
        "moderators": 1,
        "modificationDate": "2012-06-25T17:21:33.747Z",
        "occupants": 1,
        "outcasts": 0,
        "owners": 1,
        "participants": 0,
        "subject": "The current subject in the room."
      }
}