Query Meeting Configuration Templates on Pages

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

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 name	Type	IN	Required	Description
page_no	Integer	query	false	The current page number.
page_size	Integer	query	false	The number of items returned on each page.
template_name	String	query	false	The name of a specified reservation configuration template.
only_default	String	query	false	`Y`: Query the default configuration template. Values other than `Y`: Query all the templates.

Return parameter

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

Description of result

Parameter name	Type	Description
total	Long	The total number of returned entries.
list	List	The list of data.
has_more	Boolean	Specifies whether to return the next page.

Description of list

Parameter name	Type	Description
template_id	String	The ID of a specified configuration template.
template_name	String	The name of a specified configuration template.
reservation_config	MeetingRoomReservationConfigRes	The reservation settings.
sign_config	MeetingReservationSignConfigRes	The sign-in settings.
blacklist_config	MeetingRoomBlacklistConfigRes	The blocklist settings.
default_config	Boolean	Specifies whether it is a default configuration. `true`: It is a default configuration. `false`: It is not 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 a 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-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.

Prev DocDelete Meeting Configuration Template

Next DocQuery Meeting Configuration Template