English
English
简体中文
Contact Us
Register
Log In

Query Meeting Configuration Templates on Pages

Last Updated on : 2022-06-21 06:48:07

Query the information about meeting configuration templates on pages according to the specified criteria.

API address

GET: /v2.0/iot-03/meeting/config-templates-page

Request parameter

Parameter nameTypeINRequiredDescription
page_noIntegerqueryfalseThe current page number.
page_sizeIntegerqueryfalseThe number of items returned on each page.
template_nameStringqueryfalseThe name of a specified reservation configuration template.
only_defaultStringqueryfalse
  • Y: Query the default configuration template.
  • Values other than Y: Query all the templates.

Return parameter

Parameter nameTypeDescription
resultPageThe returned result. Valid values:

Description of result

Parameter nameTypeDescription
totalLongThe total number of returned entries.
listListThe list of data.
has_moreBooleanSpecifies whether to return the next page.

Description of list

Parameter nameTypeDescription
template_idStringThe ID of a specified configuration template.
template_nameStringThe name of a specified configuration template.
reservation_configMeetingRoomReservationConfigResThe reservation settings.
sign_configMeetingReservationSignConfigResThe sign-in settings.
blacklist_configMeetingRoomBlacklistConfigResThe blocklist settings.
default_configBooleanSpecifies whether it is a default configuration.
  • true: It is a default configuration.
  • false: It is not a default configuration.

Description of sign_config

Parameter nameTypeDescription
enable_signStringThe toggle of meeting sign-in.
sign_minuteIntegerThe maximum number of minutes for sign-in before the reserved time.

Description of blacklist_config

Parameter nameTypeDescription
enable_blacklistStringSpecifies whether to enable a blocklist. Valid values:
  • Y: Enable the blocklist.
  • N: Disable the blocklist.
blacklist_daysIntegerThe number of days when the trigger times of a blocklist are counted.
blacklist_timesIntegerThe number of times when a blocklist is triggered.
blacklist_disabled_daysIntegerThe duration when a blocklist is effective.

Description of reservation_config

Parameter nameTypeDescription
booking_dateListThe list of available days.
start_timeStringThe start time of the reservation.
end_timeStringThe end time of the reservation.
min_minuteIntegerThe minimum number of minutes for a single reservation.
max_hourIntegerThe maximum number of hours for a single reservation.
max_dayIntegerThe maximum number of available days before the reserved date.
release_timeIntegerThe maximum number of minutes to release a reservation if no one is present after the reserved time.

Request example

GET: /v2.0/iot-03/meeting/config-templates-page?page_no=1&page_size=1&only_default=Y

Return example

{
    "tid": "348676dc1573a7e6",
    "result": {
        "list": [
            {
                "blacklist_config": {
                    "enable_blacklist": "N"
                },
                "default_config": true,
                "sign_config": {
                    "enable_sign": "N"
                },
                "template_name": "Default Template",
                "template_id": "153189437637080****",
                "reservation_config": {
                    "min_minute": 15,
                    "booking_date": [
                        "Monday",
                        "Tuesday",
                        "Wednesday",
                        "Thursday",
                        "Friday",
                        "Saturday",
                        "Sunday"
                    ],
                    "end_time": "23:00",
                    "start_time": "07:00",
                    "max_hour": 3,
                    "max_day": 7,
                    "release_time": 10
                }
            }
        ],
        "total": 7,
        "has_more": true
    },
    "t": 1655260366709,
    "success": true
}

Error code

For more information, see error code.