Skip to content

Join room endpoint

Alvin Cheng edited this page Apr 23, 2023 · 3 revisions

Description

This is the join room endpoint, this endpoint will create a room in the database once called. The endpoint's source can be found at: /src/endpoints/joinRoom.ts. Furthermore, the endpoint will execept a 'id' argument which is the id of room to join, a 'user' argument which is the user to add to the room and finally a 'passcode' argument which as the name suggests it's the passcode for the room(This value can also be null in public rooms). Also, the endpoint will return a status of '200' on sucess, '400' on error, '401' on a invalid API key and '500' on server error.

Example

post("http://<URL>/api/join-room?key=<YOUR_API_KEY>", {
  id: "<ROOM_ID>",
  user: "<USER>",
  passcode: "<PASSCODE>", // Must be raw unencrypted passcode!!
})
  .then((res) => {
    console.log(res);
  })
  .catch((err) => {
    console.error(err);
  });
Clone this wiki locally