Skip to main content

Create rooms and departments

Summary

  • Create a room or a department anywhere in the room structure
  • Required API calls: roomService/create

Request

Request to https://apis.alfaview.com/json/v1/roomService/create

{
  "accessInfo": {
    "requestId": "### REQUEST ID ###",
    "accessToken": "### ACCESS TOKEN ###"
  },
  "room": {
    "displayName": "Conference Room 1",
    "mode": "ROOM_MODE_SPECTATOR",
    "type": "ROOM_TYPE_ROOM",
    "quotas": {
      "name": "### QUOTA NAME ###"
    },
    "permissions": {
      "### USER ID ###": "### MODERATOR ROLE ###",
      "### USER ID ###": "### PARTICIPANT ROLE ###",
      "### USER ID ###": "### PARTICIPANT ROLE ###",
    ...
    },
    "defaultPermissions": "### PARTICIPANT ROLE ###",
    ...
  }
}

Response

{
  ...
  "roomId": "b00430bd-a7ba-59db-aad9-2034464e92b9",
  ...
}

Notes

  • type should be ROOM_TYPE_ROOM when creating a room or ROOM_TYPE_DEPARTMENT when creating a department
  • mode should be ROOM_MODE_SPECTATOR in order to allow for spectators, or ROOM_MODE_NORMAL to disallow spectators (applies to room creation only)
  • parentId can be set to place the room or department under a parent room or department in the room structure, optional
  • quota should reflect the customer quota in numbers, or the name of the quota set retrieved from the quota service
  • permissions can contain a set of user ids and their associated role in this room, optional
  • defaultPermissions can be set to allow all registered users of the account to enter this room in a default permission set

Last updated on July 3rd, 2025, 12:04 pm