Public API

Endpoint	Method	Description
/seo	webRequest	Handle seo
/seo/{roomId}	webRequest	Handle seo room by id
/seo/{group}/{alias}	webRequest	Handle seo room by group alias
/api/v0/publicRpc/room.permissions	publicRpc	Permissions
/api/v0/publicRpc/room.discoverRoom	publicRpc	Discover room
/api/v0/publicRpc/room.getRoom	publicRpc	Get room
/api/v0/publicRpc/room.searchRoomsByTag	publicRpc	Search rooms by tag
/api/v0/publicRpc/init.client	publicRpc	Get data for client initialization
/api/v0/publicRpc/init.plugin	publicRpc	Get data for plugin initialization
/api/v0/publicRpc/init.application	publicRpc	Get data for application initialization
/api/v0/publicRpc/init.networkApplication	publicRpc	Get data for network application initialization
/api/v0/publicRpc/init.activeExpoNetworks	publicRpc	Active expo networks
/api/v0/publicRpc/init.getNetworkDomains	publicRpc	Get network domains
/api/v0/publicRpc/init.checkClientVersion	publicRpc	Check client version

Handle seo

HTTP Method: GET

Path: /seo

Description: Endpoint returns seo page for network. Server reads network domain from request headers: X-Request-Domain, Referer or Origin.

Request:

{ empty }

Response:

seo html page

Handle seo room by id

HTTP Method: GET

Path: /seo/

Description: Endpoint returns seo page for room by roomId or by alias.

Request:

{ empty }

Response:

seo html page

Handle seo room by group alias

HTTP Method: GET

Path: /seo/{group}/

Description: Endpoint returns seo page for room by group and alias.

Request:

{ empty }

Response:

seo html page

Permissions

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/room.permissions

Request:

{
    "roomId": string
}

Response:

{
    "data": {
        "view": bool
        "comment": bool
        "contribute": bool
        "edit": bool
        "manage": bool
    }
    "error": { "status": bool, "code": int, "message": string }
}

Discover room

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/room.discoverRoom

Description: Api returns status code 802 if room not found and 803 if user does not have permissions to view room.

Request:

{
    "roomId": string
}

Response:

{
    "data": {
        "permissions": {
            "view": bool
            "comment": bool
            "contribute": bool
            "edit": bool
            "manage": bool
        }
        "networkInfo": {
            "network": { network structure }
            "subscribed": bool
            "subscriptionOptions": [{
                "type": string  // free/one_time_payment/subscription_week/subscription_month/subscription_year
                "token": float  // subscription cost in tokens
            }]
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get room

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/room.getRoom

Description: Api returns status code 802 if room not found and 803 if user does not have permissions to view room.

Request:

{
    "roomId": string
}

Response:

{
    "data": {
        "room": { room structure }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Search rooms by tag

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/room.searchRoomsByTag

Description: Api returns list of rooms for specified tag.

• If tagSortBy == popularity, api returns most popular public rooms.
• If tagSortBy == userActivity, api returns user owned rooms and rooms where user was invited (requires authorization).

Request:

{
    "tag": string
    "tagSortBy": string  // popularity/userActivity
}

Response:

{
    "data": {
        "rooms": [{
            "room": string
            "title": string
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get data for client initialization

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/init.client

Description: If session id is not provided (or not valid), function returns info for anonymous user.

Request:

{
    "roomId": string
    "alias": string
    "group": string
    "domainName": string
}

Response:

{
    "data": {
        "endpoint": string  // https://api.roomful.net
        "networkId": string  // network id for current domain
        "network": {  // network data for current domain
            "loaderType": int  // 0 - logo, 1 - hybrid, 2 - slideshow, 3 - video
            "logoUrl": string  // url
            "loadingVideoUrl": string  // url or youtube id
            "allowRegistration": bool  // allow registration to network
            "allowAnonymous": bool  // allow network access without authorization
            "ssoProviders": [ string ]  // epam, epam.social[google,facebook,linkedin]
            "defaultPassword": string  // default password for conference
            "defaultRoom": string
            "onlyVerifiedAccounts": bool  // if true, server would require to verify email before creating new user session
            "requireZipCode": bool  // if true, zip code should be required field during registration
            "hasExpo": bool  // informs clients that the network has expo
            "pluginEnabled": bool  // imported from network plugin settings
            "shareServerHost": string  // address of share server
        }
        "sessionNetworkId": string  // network id for current session
        "room": {
            "id": string
            "created": timestamp
            "updated": timestamp
            "alias": string
            "group": string
            "domains": [ string ]
            "title": string  // room title
            "privacy": string  // private/public
            "allowEmbed": bool  // allow embedding room to non valuverse web pages
            "permissions": {  // user permissions for the room
                "view": bool
                "comment": bool
                "contribute": bool
                "edit": bool
                "manage": bool
            }
        }
        "amazon": {
            "accessKey": string
            "associateTag": string
        }
        "userId": string  // session user id
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get data for plugin initialization

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/init.plugin

Request:

{
    "networkId": string  // if provided, server will look for network by networkId
    "domainName": string  // if networkId not provided, server will look for network by domain name
}

Response:

{
    "data": {
        "networkId": string
        "pluginSettings": {
            "expoTitle": string
            "disclaimer": string
            "style": string
            "logoUrl": string
            "expositionDomain": string
            "scroll": string
            "appStoreId": string
            "googleStoreId": string
            "autoPlayOnClick": bool
            "autoPlayOnStart": bool
            "enablePlugin": bool
            "initRoute": {
                "room": string
                "prop": string
            }
            "menuItems": [{
                "directory": string
                "link": string
                "title": string
                "room": string
                "prop": string
                "target": string
                "onlyForAttendees": bool  // if true, menu item will be greyed out until user has network.attendee permission
            }]
            "helpLink": {
                "link": string
                "title": string
                "target": string
            }
            "directory": [{  // directory item could be nested or single
                "title": string
                "room": string  // target room id
                "prop": string  // target prop id
                "tag": string  // fetch rooms with a tag
                "tagSortBy": string  // popularity/userActivity
                "target": string
                "onlyForAttendees": bool  // if true, directory item will be greyed out until user has network.attendee permission
                "link": string  // link to specific route
                "interactive": bool  // can be clicked if true
                "icon": string  // empty if nested
                "items": [{ NetworkPluginDirectoryItem structure }]  // same structure as directory, if nested; empty, if single'
            }]
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get data for application initialization

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/init.application

Request:

{ empty }

Response:

{
    "data": {
        "enableSso": bool
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get data for network application initialization

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/init.networkApplication

Request:

{
    "networkId": string
}

Response:

{
    "data": {
        "disableEmailLogin": bool  // if true, client application shouldn't show email login option
        "disableSsoLogin": bool  // if true, client application shouldn't show sso login options
    }
    "error": { "status": bool, "code": int, "message": string }
}

Active expo networks

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/init.activeExpoNetworks

Request:

{
    "offset": int
    "size": int
}

Response:

{
    "data": {
        "networks": [{
            "network": { network structure }
            "settings": {
                "allowRegistration": bool  // allow registration to network
                "onlyVerifiedAccounts": bool  // if true, server would require to verify email before creating new user session
                "singleScreenAuth": bool  // if true, show registration and authorization on the same scene
                "hasDefaultPassword": bool  // true, if network has default password for conference
                "requireZipCode": bool  // if true, zip code should be required field during registration
                "ssoProviders": [ string ]  // epam, epam.social[google,facebook,linkedin]
            }
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get network domains

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/init.getNetworkDomains

Request:

{
    "networkId": string
}

Response:

{
    "data": {
        "defaultDomain": string
        "presentationDomain": string
        "studioDomain": string
    }
    "error": { "status": bool, "code": int, "message": string }
}

Check client version

Method: publicRpc

HTTP Method: POST

Path: /api/v0/publicRpc/init.checkClientVersion

Request:

{
    "clientVersion": string
}

Response:

{
    "data": {
        "status": int  // 0 - ok, 1 - require update
    }
    "error": { "status": bool, "code": int, "message": string }
}

Models

Network

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "fullName": string
    "type": string  // Public/Matchmaking/BusinessSocial/NetworkConference/Humanity
    "thumbnail": string  // resourceId
    "parentNetworkId": string  // if not empty, current network is a sub network
}

Room

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "explorerStatus": string  // show/hide room in explorer
    "subscriptionStatus": string  // free/active/expired
    "environmentId": string  // id of environment asset
    "price": float  // price for room template
    "allowEmbed": bool  // allow embedding room to non valuverse web pages
    "roomIdentity": string  // verus identity of room
    "metadata": {
        "name": string
        "description": string
        "location": string
        "privacy": string  // private/public/openForAttendees
        "tags": [ string ]
        "firstStyle": string
    }
    "alias": string
    "group": string
    "domains": [ string ]
    "thumbnail": { resource structure }
    "preview": { resource structure }
    "content": [{ room style structure }]
    "owners": [{ user simple structure }]
    "invitedUsers": [{ user simple structure }]
    "stories": [{ storyline structure }]
    "cameraPositions": [{ camera position structure }]
    "hasJourneyPath": bool
    "hasPlacementAreas": bool
    "templateStyles": [ string ]
}

Resource

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "title": string
    "description": string
    "location": string
    "date": string
    "category": string
    "linkId": string  // id of resource link is pointing to
    "linkType": string  // global/local
    "encryptionVersion": string  // encryption version, like 'verus.v1'
    "encryptionEpoch": int  // epoch defines key bundle that was used for encryption
    "encryptionEpk": string  // ephemeral public key that should be used to decrypt cypher data
    "belonging": string  // determines resource location in the system in a way 'belongingType:belongingPath(networkId)'
    "status": string  // pending/processing/ready/failed
    "metadata": {
        "fileName": string
        "fileSize": int
        "fileDate": timestamp
        "behaviourType": string
        "contentType": string
        "convertedFrom": string
        "link": string
        "origin": { resource origin structure }
        "geolocation": { geolocation structure }
        "dimensions": { dimensions structure }
    }
    "thumbnail": string
    "fromTemplate": bool
    "totalReactions": int  // amount of users who reacted to the resource
    "data": {
        "audio": { resource data audio structure }
        "video": { resource data video structure }
        "amazon": { resource data amazon structure }
        "imdb": { resource data imdb structure }
        "youtube": { resource data youtube structure }
        "pinterest": { resource data pinterest structure }
        "pixabay": { resource data pixabay structure }
        "facebook": { resource data facebook structure }
        "remoteUrl": { resource data remote url structure }
        "liveStream": { live stream data structure }
        "aiGeneration": { ai generation data structure }
        "thumbnailUrl": string
        "downloadUrl": string
        "directory": { resource data directory structure }
        "channel": { channel data structure }
        "googleDrive": { google drive structure }
    }
    "customParams": map[string]{ custom structure }  // client defined parameters
    "actions": [{ programmatic action with children structure }]  // custom programmatic actions from users
}

Resource Origin

{
    "type": string
    "device": string
    "deviceName": string
    "path": string
}

Geolocation

{
    "latitude": float
    "longitude": float
}

Dimensions

{
    "width": int
    "height": int
    "orientation": int
}

Resource Data Audio

{
    "title": string
    "artist": string
    "album": string
    "genre": string
    "duration": int
    "durationFloat": float
}

Resource Data Video

{
    "duration": int
    "durationFloat": float
    "hasAlphaChannel": bool  // true, if video generated from gif with transparent pixels
    "alphaChannel": string  // alpha channel video resource (if generated from gif)
}

Resource Data Amazon

{
    "asin": string
    "summary": string
    "author": [ string ]
    "manufacturer": string
    "title": string
    "publicationDate": string
    "url": string
}

Resource Data Imdb

{
    "Actors": string
    "Genre": string
    "Ratings": [{
        "Source": string
        "Value": string
    }]
    "Released": string
    "Runtime": string
    "Website": string
    "Year": string
    "Trailers": [ string ]
    "imdbID": string
}

Resource Data Youtube

{
    "videoId": string
    "formatId": string
}

Resource Data Pinterest

{
    "pin": string
    "url": string
}

Resource Data Pixabay

{
    "id": string
    "pageUrl": string
}

Resource Data Facebook

{
    "id": string
}

Resource Data Remote Url

{
    "url": string
    "urlType": string
    "favicon": string
    "title": string
}

Live Stream Data

{
    "streamId": string
    "assetId": string
    "playbackUrl": string
    "masterUrl": string
}

AI Generation Data

{
    "generationModel": string  // the model used for image generation [dall-e-3]
    "prompt": string  // a text description of the desired image
    "revisedPrompt": string  // the prompt that was used to generate the image, if there was any revision to the prompt
    "url": string  // the URL of the generated image
}

Resource Data Directory

{
    "innerContentType": string
    "innerContentCount": int
}

Channel Data

{
    "communityId": string
    "channelId": string
    "subChannelId": string
    "messageId": string
}

Google Drive

{
    "fileId": string
    "name": string
    "mimeType": string
}

Programmatic Action with children

{
    "localId": string  // local action id, operated by client side only
    "eventName": string
    "actionName": string
    "actionData": {
        "usedPropId": string
        "usedRoomId": string
        "usedNetworkId": string
        "usedStorylineId": string
        "usedQuestionId": int
        "usedQuestionnaireId": int
        "usedSegmentId": string
        "usedPlacementAreaId": string
        "usedRoomPoint": string
        "animationData": map[string]{ custom structure }
    }
    "childActions": [{ programmatic action structure }]
}

Programmatic Action

{
    "localId": string  // local action id, operated by client side only
    "eventName": string
    "actionName": string
    "actionData": {
        "usedPropId": string
        "usedRoomId": string
        "usedNetworkId": string
        "usedStorylineId": string
        "usedQuestionId": int
        "usedQuestionnaireId": int
        "usedSegmentId": string
        "usedPlacementAreaId": string
        "usedRoomPoint": string
        "animationData": map[string]{ custom structure }
    }
}

Room Style

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "assetId": string
    "panels": [{ room panel structure }]
}

Room Panel

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "type": string
    "mobileGeometry": { geometry structure }
    "props": [{ room prop structure }]
}

Geometry

{
    "scale": float
    "size": { xyz structure }
    "position": { xyz structure }
    "rotation": { xyz structure }
}

XYZ

{
    "x": float
    "y": float
    "z": float
}

Room Prop

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "mobileGeometry": { geometry structure }
    "title": string
    "description": string
    "tags": [ string ]
    "propTypes": [ string ]  // booth/fileCabinet/socialCircleStatic/socialCircleDynamic/entireRoomChat
    "parentId": string  // prop id of parent where current prop is standing
    "actionType": string
    "webLink": string
    "webTitle": string
    "isInteractive": bool  // show prop when clicking next/previous in room prop list
    "showType": int  // 0 - None, 1 - GoldPanel, 2 - BoothPanel
    "contentPickerType": int  // 0 - Default, 1 - AudioContainer, 2 - VideoContainer
    "contentSorting": {
        "type": string  // default/name/date/type/size
        "direction": string  // asc/desc
    }
    "contentAppend": string  // default direction for content appending (start/end)
    "isAllowTextchat": bool  // if true - allow prop textchat
    "allowUserParams": bool  // if true - allow custom params per user
    "customParams": map[string]{ custom structure }  // client defined params
    "actions": [{ programmatic action with children structure }]  // custom programmatic actions from users
    "dataBound": {  // bound prop data to some action
        "isEnabled": bool
        "dataBoundAction": string
    }
    "assetId": string
    "assetTitle": string
    "assetSkins": map[string]string  // map of selected skins per variants
    "roomId": string
    "roomTitle": string
    "styleId": string
    "panelId": string
    "placementAreaId": string  // in case if prop is a part of placement area
    "contentSource": {  // if present, current prop will fetch content from source prop
        "roomId": string
        "propId": string
    }
    "contentCount": int  // amount of resources in prop
    "content": [{ resource structure }]  // prop resources
}

User Simple

{
    "id": string
    "firstName": string
    "lastName": string
    "privacyMode": int  // 0 - Default, 1 - Incognito
    "avatar": string
    "avatar3D": {  // field is not returned if empty
        "assetId": string
        "assetSkins": map[string]string  // map of selected skins per variants
        "avatarUrl": string  // url to gbl file (Ready Player Me)
        "avatarUserId": string  // user id for session recovery (Ready Player Me)
    }
    "companyName": string  // name of company that user represents
    "companyTitle": string  // user title in the company
}

Storyline

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "title": string
    "data": string
    "published": bool
    "roomId": string
    "propId": string
}

Camera Position

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "position": { xyz structure }
    "rotation": { xyzw structure }
    "name": string
    "cameraMode": int
}

XYZW

{
    "x": float
    "y": float
    "z": float
    "w": float
}