Prop Invitations API

Endpoint	Method	Description
social:getPropTeamMembers	websocket	Get prop team members
social:getPropInvitations	websocket	Get prop invitations
social:inviteManagerToProp	websocket	Invite manager to prop
social:inviteToProp	websocket	Invite to prop
social:deletePropInvitation	websocket	Delete prop invitation
room:propInvitationCreated	websocketEvent	On prop invitation created event
room:propInvitationUpdated	websocketEvent	On prop invitation updated event
room:propInvitationDeleted	websocketEvent	On prop invitation deleted event

Get prop team members

Method: websocket

Endpoint: social:getPropTeamMembers

DEPRECATED

Description: Deprecated, use social:getPropInvitations instead.

Request:

{
    "data": {
        "roomId": string
        "propId": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "data": {
        "members": [{
            "user": { user simple structure }
            "videochat": {
                "isActive": bool  // user has active personal conference
                "videochatId": string  // videochat id of users' personal conference
            }
            "company": {  // DEPRECATED, use company info from user structure
                "companyName": string  // name of company that user represents
                "companyTitle": string  // user title in the company
            }
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get prop invitations

Method: websocket

Endpoint: social:getPropInvitations

Description: Api returns users invited to prop and their personal conference status.

Request:

{
    "data": {
        "roomId": string
        "propId": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "data": {
        "invitations": [{
            "invitation": { prop invitation info structure }
            "videochat": {
                "isActive": bool  // user has active personal conference
                "videochatId": string  // videochat id of users' personal conference
            }
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}

Invite manager to prop

Method: websocket

Endpoint: social:inviteManagerToProp

DEPRECATED

Description: Deprecated, use social:inviteToProp instead.

Request:

{
    "data": {
        "roomId": string
        "propId": string
        "invitedUser": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

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

Invite to prop

Method: websocket

Endpoint: social:inviteToProp

Request:

{
    "data": {
        "roomId": string
        "propId": string
        "invitedUser": string
        "permissions": {
            "view": bool
            "comment": bool
            "contribute": bool
            "edit": bool
            "manage": bool
        }
    }
    "event": { "id": string, "date": timestamp }
}

Response:

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

Delete prop invitation

Method: websocket

Endpoint: social:deletePropInvitation

Request:

{
    "data": {
        "roomId": string
        "propId": string
        "invitedUser": string
        "permissions": {
            "view": bool
            "comment": bool
            "contribute": bool
            "edit": bool
            "manage": bool
        }
    }
    "event": { "id": string, "date": timestamp }
}

Response:

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

On prop invitation created event

Event: room:propInvitationCreated

Data:

{
    "data": {
        "roomId": string
        "propId": string
        "invitation": { prop invitation info structure }
    }
    "error": { "status": bool, "code": int, "message": string }
}

On prop invitation updated event

Event: room:propInvitationUpdated

Data:

{
    "data": {
        "roomId": string
        "propId": string
        "invitation": { prop invitation info structure }
    }
    "error": { "status": bool, "code": int, "message": string }
}

On prop invitation deleted event

Event: room:propInvitationDeleted

Data:

{
    "data": {
        "roomId": string
        "propId": string
        "invitation": { prop invitation info structure }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Models

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
}

Prop Invitation Info

{
    "permissions": {
        "view": bool
        "comment": bool
        "contribute": bool
        "edit": bool
        "manage": bool
    }
    "invitedById": string
    "invitedUser": { user simple structure }
}