English
English
简体中文
Contact Us
Register
Log In

Query Meeting Configuration Template

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

Query the details of a specified meeting configuration template.

API address

GET: /v2.0/iot-03/meeting/config-templates/{template_id}

Request parameter

Parameter nameTypeINRequiredDescription
template_idStringuritrueThe ID of a specified configuration template.

Return parameter

Parameter nameTypeDescription
resultMeetingConfigTemplateResThe returned result. Valid values:

Description of result

Parameter nameTypeDescription
sign_configMeetingReservationSignConfigResThe sign-in settings.
template_nameStringThe name of a specified template.
reservation_configMeetingRoomReservationConfigResThe reservation settings.
blacklist_configMeetingRoomBlacklistConfigResThe blocklist settings.
template_idStringThe ID of a specified configuration template.
default_configBooleanSpecifies whether it is 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 the 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/152365128392638****

Return example

{
    "result": {
        "blacklist_config": {
            "enable_blacklist": "N"
        },
        "default_config": false,
        "sign_config": {
            "enable_sign": "N"
        },
        "template_name": "Custom Rule Template A",
        "template_id": "1523651283926388***",
        "reservation_config": {
            "booking_date": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday",
                "Friday",
                "Saturday"
            ],
            "end_time": "21:00",
            "start_time": "09:00",
            "max_hour": 2,
            "max_day": 1,
            "release_time": 9
        }
    }
}

Error code

For more information, see error code.