Get Started - Learn How To Make Your Bot!

Guides

Code Snippets

Get methods

Post methods

Web API

Useful links

List of all currently Free Items

List of Emotes

Highrise Bot SDK Changelog

Added on version 23.1.0b14

get_room(self, room_id: str) -> GetPublicRoomResponse:

Fetch a single room given its room_id.

   Args:
        **`room_id`**: The unique identifier for a room.

    Returns:
        **`GetPublicRoomResponse`**: The public data of the room.

⚙️ Use cases

Here’s a simple example to retrieve the information from a given room:

async def on_chat(self, user: User, message: str) -> None:
        if message.lower().startswith("/roominfo"):
            room = await self.webapi.get_room("61186670bd5272731251a06f")
            print (room)

Response:

GetPublicRoomResponse(
	room=Room(
		room_id='61186670bd5272731251a06f', 
		disp_name="Vini's Bedroom", 
		created_at='2021-08-15T00:57:20.245000+00:00', 
		access_policy='everyone', 
		category='hangout', 
		owner_id='6111e1fb22dcb50edf32e4a8', 
		locale=['pt'], 
		is_home_room=True, 
		num_connected=1, 
		moderator_ids=['605aba51da5a6c3e712f5808'], 
		designer_ids=['605aba51da5a6c3e712f5808'], 
		description=None, 
		crew_id=None, 
		bots='[]', 
		indicators='[]', 
		thumbnail_url='[<https://d4v5j9dz6t9fz.cloudfront.net/MediaContext.ROOMS/6111e1fb22dcb50edf32e4a8/64b4b0df90887f72d6e9d57a_0.webp>](<https://d4v5j9dz6t9fz.cloudfront.net/MediaContext.ROOMS/6111e1fb22dcb50edf32e4a8/64b4b0df90887f72d6e9d57a_0.webp>)', 
		banner_url=None))