Conference

Documentation → Conference

Overview

Userplane conferences are a collection of multi-user chat rooms. Rooms are comprised of meta data and occupant information which can be broken down into 4 roles. Occupants will be either owner, administrator, moderator, member or if no role is present a visitor.

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": {
    "rooms": [
      {
        "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."
      }]
}

Retrieve room list

GET /v1/conference.json Only rooms that are currently empty will return an empty date property telling you how long the room has been empty.

Example using Curl

curl http://uswest.api.userplane.com/v1/conference.json -v -u {siteId}:{apiKey}

Example Result

{
  "result": "Success",
  "resultCode": 200,
  "message": "",
  "error": [],
  "data": {
    "rooms": [
      {
        "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."
      }]
}