Skip to content
Chatto v0.5.0

RoomDirectoryService

Chatto exposes this service below /api/connect.

Shared message and enum definitions are documented in Shared Types And Enums.

Reads room directory data.

Lists rooms visible to the current user. Defaults to active rooms; use archive_filter to discover archived rooms or include both states. Channel rooms require membership or room.list. DM membership exposes room and participant metadata. Message-derived DM state also requires current read permission. Accessible empty DMs are included. Returns up to 100 rooms ordered by ID ascending; the default page size is 50.

POST /api/connect/chatto.api.v1.RoomDirectoryService/ListRooms

Request for rooms visible to the current user.

FieldTypeDescription
scopeRoomDirectoryScopeWhich room kinds to include. Defaults to all.
archive_filterRoomArchiveFilterArchive state to include. Defaults to ACTIVE. Combined with scope; this filter does not grant access to hidden rooms.
pagePageRequestDefaults to 50 rooms, capped at 100. Rooms are ordered by ID ascending.

One live page of rooms visible to the current user. Changes between requests can shift offsets. Follow page.has_more to read the complete directory.

FieldTypeDescription
roomsrepeated RoomWithViewerStateVisible rooms matching both the room-kind scope and archive filter.
pagePageInfoCount after visibility, scope, and archive filters, before pagination.

Lists ordered channel room groups and sidebar items visible to the current user as a finite navigation snapshot. Hidden room entries are omitted. Archived room entries are omitted.

POST /api/connect/chatto.api.v1.RoomDirectoryService/ListRoomGroups

Request for ordered room groups visible to the current user.

Finite snapshot of ordered room groups visible to the current user.

FieldTypeDescription
groupsrepeated RoomGroupChannel room groups in sidebar order.

Returns one ordered room group by ID. Hidden room entries are omitted. Archived room entries are omitted. Returns NOT_FOUND when the room group does not exist.

POST /api/connect/chatto.api.v1.RoomDirectoryService/GetRoomGroup

Request for one ordered room group visible to the current user.

FieldTypeDescription
group_idstringRequired. Room group to resolve.

One ordered room group visible to the current user.

FieldTypeDescription
groupRoomGroupResolved room group. Hidden and archived room entries are omitted.

Returns ordered room groups for a set of stable group IDs. Hidden room entries are omitted. Archived room entries are omitted. Unknown groups are omitted. Results preserve first-seen request order and repeated IDs are de-duplicated.

POST /api/connect/chatto.api.v1.RoomDirectoryService/BatchGetRoomGroups

Request visible room groups by stable group ID.

FieldTypeDescription
group_idsrepeated stringRequired room group IDs. Unknown groups are omitted from the response.

Visible room group batch response for direct group hydration.

FieldTypeDescription
groupsrepeated RoomGroupResolved room groups in first-seen request order.

Returns one visible room by ID. DM rooms require membership. Returns NOT_FOUND when the room does not exist and PERMISSION_DENIED when the room exists but is hidden from the caller.

POST /api/connect/chatto.api.v1.RoomDirectoryService/GetRoom

Request for one room visible to the current user.

FieldTypeDescription
room_idstringRequired. Room to resolve.

Room visible to the current user.

FieldTypeDescription
roomRoomWithViewerStateResolved room and viewer state.

Returns visible rooms for a set of stable room IDs. This is a direct hydration API, so visible archived rooms may be returned. Unknown rooms and rooms hidden from the caller are omitted. Results preserve first-seen request order and repeated IDs are de-duplicated.

POST /api/connect/chatto.api.v1.RoomDirectoryService/BatchGetRooms

Request visible rooms by stable room ID.

FieldTypeDescription
room_idsrepeated stringRequired room IDs. Unknown rooms and rooms hidden from the caller are omitted from the response. Archived rooms may be returned when the caller can still refresh them directly.

Visible room batch response for direct room hydration.

FieldTypeDescription
roomsrepeated RoomWithViewerStateResolved rooms in first-seen request order.