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 nameTypeINRequiredDescription
template_nameString falseThe name of a specified template.
reservation_configMeetingRoomConfigReservationReq falseThe reservation settings.
sign_configMeetingRoomConfigSignReq falseThe sign-in settings.
blacklist_configMeetingRoomConfigBlacklistReq falseThe blocklist settings.
default_configBoolean falseSpecifies whether it is a default configuration.

Description of sign_config

Parameter nameTypeINRequiredDescription
enable_signString trueThe toggle of meeting sign-in.
sign_minuteInteger falseThe maximum number of minutes for sign-in before the reserved time.

Description of blacklist_config

Parameter nameTypeINRequiredDescription
enable_blacklistString falseSpecifies whether to enable the blocklist. Valid values:
  • Y: Enable the blocklist.
  • N: Disable the blocklist.
blacklist_daysInteger falseThe number of days when the trigger times of a blocklist are counted.
blacklist_timesInteger falseThe number of times when a blocklist is triggered.
blacklist_disabled_daysInteger falseThe 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 nameTypeINRequiredDescription
booking_dateList trueThe list of available days.
start_timeString trueThe start time of the reservation.
end_timeString trueThe end time of the reservation.
min_minuteInteger trueThe minimum number of minutes for a single reservation.
max_hourInteger trueThe maximum number of hours for a single reservation.
max_dayInteger trueThe maximum number of available days before the reserved date.
release_timeInteger trueThe maximum number of minutes to release a reservation if no one is present after the reserved time.

Return parameter

Parameter nameTypeDescription
resultStringThe ID of a specified rule template.

Request example

POST: /v2.0/iot-03/meeting/config-templates
  "template_name": "Test Template",
  "reservation_config": {
    "booking_date": [
    "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.