Sign in

v1

latestOpenAPI 3.0.02026-07-13171730.7 KB
room

Create Room

Create a new room

post/rooms

Request body

namestring required

Human-readable name of the room

type'open' | 'public' | 'private' required

Room can have three different type

  • open - anyone who obtain this room url can join and replay the meet.
  • public - any member who haved joined in same worksapce can join and replay the meet.
  • private - only invited workspace user can join and replay the meet.
recordboolean

All meeting will be recorded

max_meeting_secondsinteger

Determines the maximum meeting time in seconds. Once this time has elapsed, the meeting room will be automatically terminated. The 'meeting time' refers to the duration during which two or more participants are connected. If a max_meeting_seconds is set, the timer UI will display the remaining meeting time, rather than the elapsed time.

Example request

{
  "name": "Meeting Room - 1",
  "type": "public",
  "members": [
    {
      "user_id": "000585f36eed9e8fb6b655b4",
      "type": "guest",
      "name": "user-1"
    }
  ]
}

Response

Successful operation

Example response

{
  "room": {
    "id": "000585f36eed9e8fb6b655b4",
    "application_id": "000585f36eed9e8fb6b655b4",
    "type": "public",
    "created_user_id": "#DEPRECATED#",
    "name": "Weekly Meet",
    "thumbnail_url": "https://example.url/thumbnail.png",
    "last_thumbnail_updated_at": "#DEPRECATED#",
    "room_template_id": "#DEPRECATED#",
    "layout": "SixAll",
    "meeting_time": 200000,
    "started_at": "2023-01-01T01:00:00.000Z",
    "terminated_at": "2023-01-01T01:00:00.000Z",
    "updated_at": "2023-01-01T01:00:00.000Z",
    "created_at": "2023-01-01T01:00:00.000Z"
  }
}