getTariffRestrictions

Description: Obtain information about rights and restrictions.

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

{
    "method" : "getTariffRestrictions",
    "requestId" : "1"
}

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
}

Parameter description:

• p2pSchema - a set of possible combinations of the number of broadcasting participants to the total number of participants for a video call

• symmetricSchema - a set of possible combinations of the number of broadcasting participants to the total number of participants for everyone on screen

• asymmetricSchema - a set of possible combinations of the number of broadcasting participants to the total number of participants for a video lecture

• roleSchema - a set of possible combinations of the number of broadcasting participants relative to the total number of participants for the video layout

• smartMeetingSchema - a 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

• maxCasters - the maximum number of participants that can simultaneously be on the podium for the given video communication mode

• maxParticipants - the maximum number of participants in a conference or call

• tariffName— the plan (subscription) name

• p2p - a flag indicating if video calls are available

• createMulti - a flag indicating whether the creation of group conferences is available

• symMaxNumber - the number of participants that can simultaneously be on screen in a all on screen group conference

• asymMaxNumber — the field showing how many users can simultaneously participate in a video lecture

• roleMaxNumber — Field that shows information about how many people can simultaneously participate in a role-based conference

• rlMaxNumber - field containing the maximum possible number of presenters who can simultaneously be on the podium

• canUseSlideShow — the field indicating if slideshow is allowed

• canUseDesktopSharing — the field indicating if content sharing is allowed

• canChangeAddressBook — the field indicating if address book can be edited

• canEditGroups — the field indicating if address book groups can be edited

• canUseDialer — the flag indicating if it is possible to use the "dialer" (tone dialing)

• requestId - a unique request identifier. You can learn more about it here.

See also:

• getSystemInfo
• tariffRestrictionsChanged