Internal API

In this chapter, we document the internal API of venueless. This is the API used to communicate between our frontend web application and the server-side component.

We do not consider this API to be stable in any way and it may change between different versions of venueless without warning.

Contents:

• Websocket connection
  • Generic RPC
  • Keepalive
  • Connection management
• User/Account handling
  • Logging in
  • User objects
  • Change user info
  • Receiving info on another user
  • Profile updates
  • Fetching a list of users
  • Searching users
  • Managing users
  • Blocking users
  • Connecting a social media account
• World configuration
• Schedule updates
• Permission model
  • User types
  • Permissions
  • Roles
  • Explicit grants
  • Implicit grants and traits
• World actions
  • Room creation
  • World configuration
• Rooms
  • Room navigation
  • Viewers
  • Reactions
  • Room management
  • Schedule changes
  • Anonymous invites
• Chat module
  • Channels
  • Membership and subscription
  • Channel list
  • Direct messages
  • Events
  • Read/unread status
• Announcements module
  • Creating or updating an announcement
  • Receiving announcements
  • List announcements
• BigBlueButton module
  • BBB Rooms
  • Private conversations
  • Recordings
• File uploads
• Exhibition module
  • Message flow
  • Contact request
  • Cancel contact request
• Poster module
  • Room view API
  • Management API
• Polls
  • Permissions
  • Room Config
• Questions
  • Permissions
  • Room Config
  • TODOs
• Roulette module
  • Handshake
  • Hangup