Query a Specific Meeting Room

Query the detailed information of a specific meeting room.

Request URL

GET {base_url}/services/openapi/v1.0/room/room_detail/{roomId}

Request parameters

Path parameters


Parameter	Required	Type	Description
roomId	Yes	Long	The ID of the meeting room. Note: You can query the room ID using the Query Multiple Meeting Rooms interface.

Response parameters


Parameter	Type	Description
data	Object <Details>	The detailed information.
status	String	The result of the request. `Success` `Failed`
requestId	String	The ID of the request, which can be used to quickly locate the request.

Detail


Parameter	Type	Description
roomId	Long	The ID of the meeting room.
name	String	The name of the meeting room.
buildingName	String	The name of the building where the meeting room is located.
buildingId	Long	The ID of the building where the meeting room is located.
floorName	String	The name of the floor where the meeting room is located.
floorId	Long	The ID of the floor where the meeting room is located.
capacity	Integer	The maximum number of people the meeting room can accommodate.
facility	Array <Fac_Info>	The available facilities in the meeting room.
type	String	Meeting room type. `common`: Regular Meeting Room. `approval`: Request-only Room. `special`: Dedicated Meeting Room.
bookingMemberIds	Array <Long>	The member ID(s) of the user(s) with the permission to book the meeting room.
bookingGroupIds	Array <Long>	The ID(s) of the user group(s) with the permission to book the meeting room.
approvalmemberIds	Array <Long>	The member ID(s) of the user(s) that have the privilege to approve reservation requests for the meeting room. Note: This parameter is only returned for Request-only Meeting Room.
approvalGroupIds	Array <Long>	The ID(s) of the user group(s) that have the privilege to approve reservation requests for the meeting room. Note: This parameter is only returned for Request-only Meeting Room.
remark	String	Remark.
restrictInWorkingHours	Boolean	Whether the meeting room booking is restricted to the company working hours. `true`: Enabled. The meeting room can only be booked during working hours. `false`: Disabled. The meeting room can be booked at any time.
minDuration	Integer	The minimum duration that the meeting room can be reserved for (Unit: minute).
maxDuration	Integer	The maximum duration that the meeting room can be reserved for (Unit: minute). Note: If the value is `-1`, it indicates that the duration is unlimited.
bookingWindow	Integer	How far in advance can the meeting room be booked (Unit: day).
repeatBooking	Boolean	Whether the meeting room is allowed for recurring booking. `true`: Allowed. `false`: Not allowed.
checkInRequired	Boolean	Whether check-in is required for meetings in the meeting room. `true`: Required. `false`: Not required.
checkInWindow	Integer	How far in advance can users check in to the meeting room reservations before the meeting starts (Unit: minute).
checkInPermission	String	Who can check in to the meeting room reservations. `ONLY_ORGANIZER`: Organizer only. `ANY_PARTICIPANTS`: Organizer or any participants.
checkInCount	Boolean	Whether meeting participant check-in is enabled for attendee counting. `true`: Enabled. `false`: Disabled.
notcheckInAutoRelease	Boolean	Whether the meeting room will be auto-released upon check-in timeout. `true`: Enabled. If no check-in occurs within the check-in timeout, the meeting room will be released automatically. `false`: Disabled.
checkInTimeout	Integer	The check-in timeout (Unit: minute).
endPermission	String	Who can end the meetings. `ONLY_ORGANIZER`: Organizer only. `ANY_PARTICIPANTS`: Organizer or any participants.
deviceNames	String	The name of the smart devices that are associated with the meeting room.
displayBooking	Boolean	Whether users can book the meeting room on its associated Room Display. `true`: Enabled. `false`: Disabled.
unoccupiedAutoRelease	Boolean	Whether an in-use meeting room will be auto-released if the associated People Counting Sensor continuously detects that the room is empty within the unoccupied auto-release timeout. `true`: Enabled. `false`: Disabled.
unoccupiedDuration	Integer	Meeting room unoccupied auto-release timeout (Unit: minute).
lightOnCheckedIn	Boolean	Whether the associated Smart Switch will automatically turn on the lights in the meeting room when users check in. `true`: Enabled. `false`: Disabled.
lightOffEnded	Boolean	Whether the associated Smart Switch will automatically turn off the lights in the meeting room when a meeting ends. `true`: Enabled. `false`: Disabled.
lightOnOffWork	Boolean	Whether the associated Smart Switch will automatically turn off the lights in the meeting room during non-working hours. `true`: Enabled. `false`: Disabled.
accessControl	Boolean	Whether access control is enabled for the meeting room. `true`: Enabled. `false`: Disabled.

Fac_Info


Parameter	Type	Description
facilityId	Long	The ID of the facility.
facilityName	String	The name of the facility.

Example

Request example

Query the detailed information of a meeting room (ID: 2812).

GET /services/openapi/v1.0/room/room_detail/2812 HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjODA0ZDNhNy1mYWU2LTRmYWQtYmExMi1kNDQ0MGJjYzBiMjMiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTczNjk1NCwiZXhwX2luIjo4NjQwMH0.EybcV1rsw9oPoYd4vfLkfLbCKRobiXYXyyP80RDrghM

Response example

HTTP/1.1 200 OK
{
    "data": {
        "roomId": 2812,
        "name": "Meeting Room 8",
        "buildingName": "Yeastar",
        "buildingId": 29,
        "floorName": "2F",
        "floorId": 32,
        "capacity": 8,
        "facility": [
            {
                "facilityId": 145,
                "facilityName": "Laptop Converter"
            },
            {
                "facilityId": 143,
                "facilityName": "Whiteboard"
            }
        ],
        "type": "common",
        "bookingMemberIds": [
            3084,
            466
        ],
        "bookingGroupIds": [
            1000202,
            1000203
        ],
        "remark": "Regular meeting room",
        "restrictInWorkingHours": true,
        "minDuration": 30,
        "maxDuration": 180,
        "bookingWindow": 365,
        "repeatBooking": true,
        "checkInRequired": true,
        "checkInWindow": 5,
        "checkInPermission": "ONLY_ORGANIZER",
        "checkInCount": true,
        "notcheckInAutoRelease": true,
        "checkInTimeout": 10,
        "endPermission": "ANY_PARTICIPANTS",
        "deviceNames": "visitor-screen 302",
        "displayBooking": true,
        "unoccupiedAutoRelease": true,
        "unoccupiedDuration": 15,
        "lightOnCheckedIn": false,
        "lightOffEnded": false,
        "lightOnOffWork": false,
        "accessControl": false
    },
    "status": "Success",
    "requestId": "085cebbc0f8becdd6f91f5af601913d1"
}