Query Meeting Configuration Template

Last Updated on : 2023-06-21 07:13:01

Query the details of a specified meeting configuration template.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
template_id	String	uri	true	The ID of a specified configuration template.

Return parameter

Parameter name	Type	Description
result	MeetingConfigTemplateRes	The returned result. Valid values:

Description of result

Parameter name	Type	Description
sign_config	MeetingReservationSignConfigRes	The sign-in settings.
template_name	String	The name of a specified template.
reservation_config	MeetingRoomReservationConfigRes	The reservation settings.
blacklist_config	MeetingRoomBlacklistConfigRes	The blocklist settings.
template_id	String	The ID of a specified configuration template.
default_config	Boolean	Specifies whether it is a default configuration.

Description of sign_config

Parameter name	Type	Description
enable_sign	String	The toggle of meeting sign-in.
sign_minute	Integer	The maximum number of minutes for sign-in before the reserved time.

Description of blacklist_config

Parameter name	Type	Description
enable_blacklist	String	Specifies whether to enable the blocklist. Valid values: `Y`: Enable the blocklist. `N`: Disable the blocklist.
blacklist_days	Integer	The number of days when the trigger times of a blocklist are counted.
blacklist_times	Integer	The number of times when a blocklist is triggered.
blacklist_disabled_days	Integer	The duration when a blocklist is effective.

Description of reservation_config

Parameter name	Type	Description
booking_date	List	The list of available days.
start_time	String	The start time of the reservation.
end_time	String	The end time of the reservation.
min_minute	Integer	The minimum number of minutes for a single reservation.
max_hour	Integer	The maximum number of hours for a single reservation.
max_day	Integer	The maximum number of available days before the reserved date.
release_time	Integer	The 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.

Prev DocQuery Meeting Configuration Templates on Pages

Next DocLink Meeting Room with Template