⭐Get or Create Default Room

Gets the user's default room. If it doesn't exist, creates a new default room.

Below is a list of available parameters when creating a default room

Parameter	Type	Required	Default	Description
creator_email	string	Yes	n/a	Email address of the user who will own the room. Must be registered in the system
name	string	Yes	n/a	Room name
fallback_name	string	No	null	Alternative name to use if room name conflicts
lang	string	No	en-US	Room session language code(see)
options	Session Options Object	No	See object	Room session options(see)

General:

• Each user can have only one default room

• When the room is created, the creator_email owner is automatically added as a instructor

name parameter:

• The name parameter must be unique for a room

creator_email parameter:

• Must be in valid email format

• The specified email address must belong to a user registered in the system

Example request

CURL

curl -L -X POST 'https://<DOMAIN>/xapi/v2/room' \
-H 'Content-Type: application/json' \
--data-raw '{
  "name": "Test Room",
  "fallback_name": "Test Room  Fallback",
  "lang": "en-US",
  "creator_email": "[email protected]",
  "options": {
    "allow_rating": true,
    "preparation_time": 15,
    "session_duration": 60,
    "Chat": {
      "OffMessageModule": false,
      "OffGeneralMsging": false,
      "OffGeneralMsgLimitForUser": false,
      "OffSpecialMsging": false,
      "OffSpecialMsgToAdmin": false,
      "OffSpecialMsgToUser": false,
      "OffNewMsgSound": false,
      "OffClearForReplay": false,
      "OnNewMsgSoundInAll": false,
      "OnNewMsgNotifyInAll": false
    },
    "Duration": {
      "AllowExtendTime": true,
      "UseRemainingTime": false
    },
    "allow_users_stream_self_cam_mic": true,
    "hide_user_streams": false,
    "enable_attendance_check": true,
    "enable_simultaneous_interpretation": false,
    "enable_simultaneous_interpretation_for_users": false,
    "start_active": false,
    "return_url": "",
    "allow_reactions": true
  }
}'

Example response

You need to save the ROOM_GUID parameter to perform other operations related to the room

• If the user's default room already exists, returns the existing room with 200 OK

• If the user's default room does not exist, creates a new one and returns with 201 Created

A successful response returns the following body:

{
  "room_guid": "B5530B7F-6414-4046-87A6-67730D5F9F08",
  "name": "Test Room",
  "lang": "en-US",
  "url": "https://yourdomain.com/groups/room/test-room_{0}",
  "created_date": "2025-08-19T12:59:00",
  "ui_options": {
    "allow_rating": true,
    "preparation_time": 15,
    "session_duration": 60,
    "chat": {
      "offMessageModule": false,
      "offGeneralMsging": false,
      "offGeneralMsgLimitForUser": false,
      "offSpecialMsging": false,
      "offSpecialMsgToAdmin": false,
      "offSpecialMsgToUser": false,
      "offNewMsgSound": false,
      "offClearForReplay": false,
      "onNewMsgSoundInAll": false,
      "onNewMsgNotifyInAll": false
    },
    "duration": {
      "allowExtendTime": true,
      "useRemainingTime": false
    },
    "allow_users_stream_self_cam_mic": true,
    "hide_user_streams": false,
    "enable_attendance_check": true,
    "enable_simultaneous_interpretation": false,
    "enable_simultaneous_interpretation_for_users": false,
    "start_active": false,
    "return_url": "",
    "allow_reactions": true
  }
}