Query Meeting Room Access Permission

Query if a user has the access permission to an access control enabled meeting room.

Prerequisites

The access control feature of the meeting room is enabled.
Tip: For more information about access control device setup, see Set up Access Control for Meeting Room.

Request URL

POST {base_url}/services/openapi/v1.0/device/open_door

Request parameter

Body parameters
Parameter Required Type Description
memberId Yes Long User's member ID.
Note: You can query the user's member ID using the Query Multiple Users interface.
roomId Yes Long Meeting room ID.
Note: You can query the meeting room ID using the Query Multiple Meeting Rooms interface.

Response parameter

Parameter Type Description
data Object <Details> The information about the upcoming or ongoing meeting in the meeting room.
Note: This parameter will be returned only when there is an upcoming or ongoing meeting in this meeting room.
status String The result of the request.
  • Success: The user has the access permission to the meeting room.
  • Failed: The user doesn't have access permission to the meeting room.
requestId String The ID of the request, which can be used to quickly locate the request.
Details
Parameter Type Description
meetingId Integer Meeting ID.
meetingStatus String Meeting status.
  • WILL_START: The meeting is about to start.
  • STARTED: The meeting has started.

Example

Request structure

Query if a user (member ID: 455) has the access permission to a meeting room (ID: 2863). 
POST /services/openapi/v1.0/device/open_door HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJkMjI1NWZlZi1mYmFhLTQ3NmEtYjhiNi1jYzI0ZTI2MjM2ZmUiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTk5MTY4NywiZXhwX2luIjo4NjQwMH0.n89H7wMZQL9PA3-LFXoSr75D0EvsDwgcznA55FPCZxU
Content-Type: application/json

{
    "memberId": 466,
    "roomId": 2863
}
Response structure
HTTP/1.1 200 OK
{
    "data": {
        "meetingId": "WzEsNzQwMTAsMCwxNjkwMjQ5NTAwLDBd",
        "meetingStatus": "WILL_START"
    },
    "status": "Success",
    "requestId": "73bcf628b302ec0fa53ae3cda005f1d3"
}