Skip to content

VoiceRoomSummary

What the page of a voice chat room shows to a visitor who does not see the room, such as a visitor who is not signed in or a user of another server: only the users of this server join its rooms. name is present only when the server shows the summaries of its rooms (the instance setting voice_public_summary) and the room is for every local user (the local visibility); description and host then come too while the room is open. The participants are never shown.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
state
required

Whether the room is open or ended.

string
Allowed values: open ended
name

The name of the room.

string
icon

The icon of the room; present only with name, and omitted when the room has none.

Schema: VoiceRoomIcon

object
description

The description of the room, empty for none.

string
host

Schema: Account

object

Example generated

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"state": "open",
"name": "example",
"icon": {},
"description": "example",
"host": {}
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site