Add Meeting Configuration Template

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

Add a meeting configuration template based on the settings of reservation, sign-in, and blocklist.

API address

POST: /v2.0/iot-03/meeting/config-templates

Request parameter

Description of body

Parameter name	Type	Required	Description
template_name	String	false	The name of a specified template.
reservation_config	MeetingRoomConfigReservationReq	false	The reservation settings.
sign_config	MeetingRoomConfigSignReq	false	The sign-in settings.
blacklist_config	MeetingRoomConfigBlacklistReq	false	The blocklist settings.
default_config	Boolean	false	Specifies whether it is a default configuration.

Description of sign_config

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

Description of blacklist_config

Parameter name	Type	Required	Description
enable_blacklist	String	false	Specifies whether to enable the blocklist. Valid values: `Y`: Enable the blocklist. `N`: Disable the blocklist.
blacklist_days	Integer	false	The number of days when the trigger times of a blocklist are counted.
blacklist_times	Integer	false	The number of times when a blocklist is triggered.
blacklist_disabled_days	Integer	false	The number of days during which meeting reservation is disabled, after a blocklist is triggered for the specified number of times.

Description of reservation_config

Parameter name	Type	Required	Description
booking_date	List	true	The list of available days.
start_time	String	true	The start time of the reservation.
end_time	String	true	The end time of the reservation.
min_minute	Integer	true	The minimum number of minutes for a single reservation.
max_hour	Integer	true	The maximum number of hours for a single reservation.
max_day	Integer	true	The maximum number of available days before the reserved date.
release_time	Integer	true	The maximum number of minutes to release a reservation if no one is present after the reserved time.

Return parameter

Parameter name	Type	Description
result	String	The ID of a specified rule template.

Request example

POST: /v2.0/iot-03/meeting/config-templates

{
  "template_name": "Test Template",
  "reservation_config": {
    "booking_date": [
      "Monday",
      "Wednesday",
      "Tuesday",
      "Friday",
      "Thursday"
    ],
    "start_time": "03:03",
    "end_time": "08:06",
    "max_hour": "10",
    "max_day": "2",
    "release_time": "30"
  },
  "sign_config": {},
  "blacklist_config": {}
}

Return example

{
    "result": "140179311206545****",
    "t": 1623048496696,
    "success": true
}

Error code

For more information, see error code.

Prev DocLink Meeting Room with Template

Next DocSeat Management of Campus Office