getTariffRestrictions

TrueConf7/5/26About 4 min

getTariffRestrictions

Description

Obtain information about rights and restrictions

All parameters in the command response are available only when the user is authorized

void getTariffRestrictions()

Response example

{
    "method": "getTariffRestrictions",
    "requestId": "",
    "tariffName": "",
    "p2p": true,
    "createMulti": true,
    "symMaxNumber": 49,
    "asymMaxNumber": 49,
    "roleMaxNumber": 250,
    "rlMaxNumber": 4,
    "canUseSlideShow": true,
    "canUseDesktopSharing": true,
    "canChangeAddressBook": true,
    "canEditGroups": true,
    "canUseDialer": true,
    "p2pSchema": [
        {
            "maxCasters": 1,
            "maxParticipants": 1
        }
    ],
    "symmetricSchema": [
        {
            "maxCasters": 49,
            "maxParticipants": 49
        }
    ],
    "asymmetricSchema": [
        {
            "maxCasters": 1,
            "maxParticipants": 49
        }
    ],
    "roleSchema": [
        {
            "maxCasters": 1,
            "maxParticipants": 1500
        },
        {
            "maxCasters": 2,
            "maxParticipants": 900
        },
        {
            "maxCasters": 3,
            "maxParticipants": 600
        }
    ],
    "smartMeetingSchema": [
        {
            "maxCasters": 4,
            "maxParticipants": 450
        },
        {
            "maxCasters": 5,
            "maxParticipants": 450
        },
        {
            "maxCasters": 6,
            "maxParticipants": 420
        }
    ],
    "result": true
}

Response Parameters

NameDescription
p2pSchemaA set of possible combinations of the number of broadcasting participants to the total number of participants for a video call
symmetricSchemaA set of possible combinations of the number of broadcasting participants to the total number of participants for everyone on screen
asymmetricSchemaA set of possible combinations of the number of broadcasting participants to the total number of participants for a video lecture
roleSchemaA set of possible combinations of the number of broadcasting participants relative to the total number of participants for the video layout
smartMeetingSchemaA set of possible combinations of the number of broadcasting participants to the total number of participants for the video selector in the mode Automatic stage entrance by VAD
maxCastersThe maximum number of participants that can simultaneously be on the podium for the given video communication mode
maxParticipantsThe maximum number of participants in a conference or call
tariffNameThe plan (subscription) name
p2pA flag indicating if video calls are available
createMultiA flag indicating whether the creation of group conferences is available
symMaxNumberThe number of participants that can simultaneously be on screen in a all on screen group conference
asymMaxNumberThe field showing how many users can simultaneously participate in a video lecture
roleMaxNumberThe field that shows information about how many people can simultaneously participate in a role-based conference
rlMaxNumberThe field containing the maximum possible number of presenters who can simultaneously be on the podium
canUseSlideShowThe field indicating if slideshow is allowed
canUseDesktopSharingThe field indicating if content sharing is allowed
canChangeAddressBookThe field indicating if address book can be edited
canEditGroupsThe field indicating if address book groups can be edited
canUseDialerThe flag indicating if it is possible to use the "dialer" (tone dialing)
requestIdA unique request identifier
resultA flag indicating whether the request was successful

See also

Last Updated: