Skip to content

VoiceRoomPage

A page of the open voice chat rooms that the user sees: the rooms where the user follows the host or a speaker first, then by the most participants.

object
next_cursor

An opaque pagination cursor. Clients pass it back unchanged and never parse it.

string
>= 1 characters <= 256 characters
items
required
Array<object>

An open voice chat room: its settings, its host, and its participants in the order they joined. Everyone who sees the room sees its participants.

object
id
required

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

string format: uuid
name
required

The name of the room, 1 to 100 characters.

string
icon

Schema: VoiceRoomIcon

object
description
required

The description of the room, up to 500 characters; empty for none.

string
hashtags
required

The hashtags of the room, without the #, as the host typed them.

Array<string>
visibility
required

Who sees a voice chat room and may join it: local every local user, followers the followers of the current host, following those whom the host follows, mutuals those who follow the host and whom the host follows, and invited only the invited users. The host, the co-hosts, the participants, and the invited users always see it, and a block with the host or a co-host always hides it.

string
Allowed values: local followers following mutuals invited
speakers
required

Who may become a speaker without asking: everyone, followers of the current host, following (those whom the host follows), mutuals with the host, or manual (nobody: the host and the co-hosts let them speak).

string
Allowed values: everyone followers following mutuals manual
host
required

Schema: Account

object
opened_at
required

When the room opened.

string format: date-time
participants_count
required

How many people are in the room, the host included.

integer
participants
required
Array<object>

A participant of a voice chat room.

object
account
required

Schema: Account

object
role
required

Whether a participant speaks or listens.

string
Allowed values: speaker listener
hosting
required

Whether the participant is the host.

boolean
cohosting
required

Whether the participant is a co-host. The host is never a co-host.

boolean
hand_raised
required

Whether the participant raised a hand to speak.

boolean
blocked
required

Whether the user blocks the participant or the participant blocks the user.

boolean
session

The live session of the participant, in the state events of a room stream only; the sessions connect to each other with signals.

string
can_speak
required

Whether the user may become a speaker in the room now without raising a hand (POST /voice/rooms/{id}/speaker): true for the host and the co-hosts, and for the participants with a permission to speak (a granted raised hand, a grant, or an invitation as a speaker) or whom the room’s speakers setting covers, unless a moderator limited them and they have no permission. False for any other user who is not in the room.

boolean

Example generated

{
"next_cursor": "example",
"items": [
{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"name": "example",
"icon": {},
"description": "example",
"hashtags": [
"example"
],
"visibility": "local",
"speakers": "everyone",
"host": {},
"opened_at": "2026-04-15T12:00:00Z",
"participants_count": 1,
"participants": [
{
"account": {},
"role": "speaker",
"hosting": true,
"cohosting": true,
"hand_raised": true,
"blocked": true,
"session": "example"
}
],
"can_speak": true
}
]
}

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

Analytics on this site