Join a room

Allows a user to join an existing video call room with less than 4 participants, or creates a new room if none are available. Also returns a list of potential invite candidates if a new room is created.

POST /room_join

Error

A valid request URL is required to generate request examples

200

{
  "status": "success",
  "message": "Operation completed successfully",
  "room_code": "Room123ABC",
  "invite_candidates": [
    123
  ]
}

Body

application/json

user_id · integer · required

ID of the user joining the room.

Example:

201

Response

200

application/json

Room joined/created successfully.

status · string

Example:

"success"

message · string

Example:

"Operation completed successfully"

room_code · string

The code of the room the user joined or created.

Example:

"Room123ABC"

invite_candidates · integer[]

List of user IDs that are available for invitation if a new room was created.