Create a Meeting Room
Create a meeting room.
Request URL
POST {base_url}/services/openapi/v1.0/room/room_create
Request parameters
Body parameters
Parameter | Required | Type | Description |
---|---|---|---|
name | Yes | String | The name of the meeting room. |
buildingName | Yes | String | The name of the floor where the meeting room is located. |
floorName | No | String | The name of the building where the meeting room is located. |
capacity | No | Integer | The maximum number of people the meeting room can accommodate. |
facilityName | No | String | The name of the available facilities in the meeting
room. Note: Use a comma to separate
multiple facilities. For example, "Projector,Laser
Pointer" . |
type | Yes | String | Meeting room type.
|
bookingMemberIds | No | Array <Long> | The member ID(s) of the user(s) with the permission to book
the meeting room. Note:
|
bookingGroupIds | No | Array <Long> | The ID(s) of the user group(s) with the permission to book
the meeting room. Note:
|
approvalMemberIds | No | Array <Long> | The member ID(s) of the user(s) that have the privilege to
approve reservation requests for the meeting room. Note:
|
approvalGroupIds | No | Array <Long> | The ID(s) of the user group(s) that have the privilege to
approve reservation requests for the meeting room. Note:
|
remark | No | String | Remark. |
restrictInWorkingHours | No | Boolean | Whether to restrict the meeting room booking to the company
working hours. Valid value:
|
minDuration | No | Integer | The minimum duration that the meeting room can be reserved
for (Unit: minute). Valid range: 15 - 60. |
maxDuration | No | Integer | The maximum duration that the meeting room can be reserved
for (Unit: minute). Valid range: 60 - 480. Note: If you don't want to limit the
reservation duration of the meeting room, set the parameter
to -1 . |
bookingWindow | No | Integer | How far in advance can the meeting room be booked
(Unit: day). Valid range: 1 - 365. |
repeatBooking | No | Boolean | Whether to enable recurring booking for the meeting
room. Valid value:
|
checkInRequired | No | Boolean | Whether check-in is required for the meeting room
reservations. Valid value:
|
checkInWindow | No | Integer | How far in advance can users check in to the meeting room
reservation before the meeting starts. Valid range: 5 - 15. |
checkInPermission | No | String | Who can check in to the meeting room reservations. Valid
value:
|
checkInCount | No | Boolean | Whether to enable meeting participant check-in for attendee
counting. Valid value:
|
notcheckInAutoRelease | No | Boolean | Whether to auto release the meeting room if no check-in
occurs within the check-in timeout. Valid value:
|
checkInTimeout | No | Integer | Check-in timeout (Unit: minute). Valid range: 5 - 30. |
endPermission | No | String | Who can end the meeting. Valid value:
|
deviceNames | No | String | The name of the smart devices to be associated with the
meeting room. Note: Use a comma to separate multiple
devices. For example,
"visitor-screen,LoRagateway" . |
displayBooking | No | Boolean | Whether user can book the meeting room on its associated Room
Display. Valid value:
|
unoccupiedAutoRelease | No | Boolean | Whether to auto release an in-use meeting room when the
associated People Counting Sensor continuously detects the room
is empty within the unoccupied auto-release timeout. Valid value:
|
unoccupiedDuration | No | Integer | Meeting room unoccupied auto-release timeout (Unit:
minute). Valid range: 15 - 30. |
lightOnCheckedIn | No | Boolean | Whether the associated Smart Switch will automatically turn
on the lights in the meeting room when users check
in. Valid value:
|
lightOffEnded | No | Boolean | Whether the associated Smart Switch will automatically turn
off the lights in the meeting room when a meeting ends.
Valid value:
|
lightOnOffWork | No | Boolean | Whether the associated Smart Switch will automatically turn
off the lights in the meeting room during non-working hours.
Valid value:
|
accessControl | No | Boolean | Whether to enable access control for the meeting room. Note: To implement access control of a
meeting room, make sure that you have connected the meeting
room's associated Room Display with an access control
devices. Valid value:
|
Response parameters
Parameter | Type | Description |
---|---|---|
data | Object <Details> | The detailed information. |
status | String | The result of the request.
|
requestId | String | The ID of the request, which can be used to quickly locate the request. |
- Details
-
Parameter Type Description roomId Long The ID of the meeting room.
Example
Request example
Create a request-only meeting room.
POST /services/openapi/v1.0/room/room_create HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImF0aSI6IjEyNGFmMGI3LWNjMzgtNGEwZC1hZWIwLTEyNWYxNzIwZWRmYyIsImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2ZDRkMGFhMi0wYWY4LTQ5NTctOWFkYS1hOWM4ZmFhMDc4ODciLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTc2NDMwNywiZXhwX2luIjo4NjM5OX0.qJg3rOhz5rPtXKyO0mVFeL_TmHExNzhYU2g-1XIOBzo
Content-Type: application/json
{
"name": "Test Meeting Room",
"buildingName": "Yeastar",
"floorName":"2F",
"capacity":8,
"facilityName": "Projector,Laser Pointer",
"type": "approval",
"bookingMemberIds": [3084,466],
"approvalMemberIds":[3084],
"remark": "For Test",
"restrictInWorkingHours":true,
"minDuration":30,
"maxDuration": 300,
"bookingWindow":365,
"repeatBooking":true,
"checkInRequired":true,
"checkInWindow":15,
"checkInPermission":"ANY_PARTICIPANTS",
"checkInCount":true,
"notcheckInAutoRelease":true,
"checkInTimeout":15,
"endPermission": "ANY_PARTICIPANTS",
"deviceNames": "visitor-screen,LoRagateway",
"displayBooking":true,
"unoccupiedAutoRelease":true,
"unoccupiedDuration":15,
"lightOnCheckedIn":true,
"lightOffEnded":true,
"lightOnOffWork":true,
"accessControl":true
}
Response example
HTTP/1.1 200 OK
{
"data": {
"roomId": 3086
},
"status": "Success",
"requestId": "1d0991dd466ea1aa1918962a71c80ac8"
}