getRoomDetails()

Get Room Details

getRoomDetails() method helps to retrieve information about specific roomId.

import { API } from '@huddle01/server-sdk/api';
 
const roomDetails = async () => {
  const api = new API({
    apiKey: process.env.API_KEY!,
  });
 
  const roomDetails = await api.getRoomDetails({
    roomId: 'YOUR_ROOM_ID',
  });
 
  return roomDetails;
};

Returns

getRoomDetails() will return all details about room, if it's token gated it will also return tokenGatingInfo.

NameTypeDescription
roomIdstringThe unique identifier for Room
roomLockedbooleanThe state of room indicating if it is locked
metadataunknownThe metadata associated with the Room
{
  "roomId": "nvw-fxtj-gha",
  "roomLocked": true,
  "metadata": {
    "hosts": [],
    "title": "",
    "roomType": "video",
    "meetingLink": "https://akmo.huddle01.com/voy-kpsa-hpo"
  }
}
Audio/Video Infrastructure designed for developers to empower them to ship simple yet powerful Audio/Video Apps.
support
company
Copyright © 2024 Graphene 01, Inc. All Rights Reserved.