Check-in or check-out of a Zoom Room

PATCH

/rooms/{id}/events

Rooms

The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either check in and confirm that you are utilizing the room reservation or to check out of the room so that the room gets released from the scheduled meeting and will be made available for others to use. Learn more from the Using the Zoom Rooms check-in feature guide.

Prerequisites:

Zoom Rooms must have been set up for use for the account and must be online.

You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the Room.

Scope: room:write:admin

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'http://api.zoom.us/v2/rooms//events'

响应示例

202 - 示例 1

null

请求参数

Path 参数

string

Room ID

必需

Body 参数multipart/form-data

method

string

可选

The value of this field can be one of the following:

zoomroom.check_in

zoomroom.check_out

params

object

可选

calendar_id

string

可选

This field is only required if Google Calendar is being used for the event associated with the Zoom Room. The value for this field can be retrieved by calling Google's CalendarList:list API and referring to the "id" field included in the calendarList resource.

change_key

string

可选

This field is required only for Microsoft Exchange or Office 365 calendar. The change key represents the specific version of the calendar item and can be retrieved by using Microsoft's FindItem Operation and referring to the ChangeKey field of the ItemId Element included in the operation response.

event_id

string

必需

Unique Identifier of the calendar event associated with the Zoom Room.

If the calendar integration being used is Microsoft Exchange, the value for this field can be retrieved by using Microsoft's FindItem Operation and referring to the Id field of the ItemId Element included in the operation response.

If the Google calendar integration was used for this event, the event_id can be retrieved by calling Google's Events:list API and referring to the "id" field included in the events resource.

resource_email

string <email>

可选

This field is only required for Microsoft Exchange / Office 365 Calendar. It is the resource mailbox associated with the calendar.

返回响应

🟢202**HTTP Status Code:** `202` **Accepted** Request processed successfully.

application/json

Body

No schema defined

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `300` * Zoom Room is offline. Please ensure that the Zoom Room is online before checking in or checking out. * Invalid parameters.

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `1012` Room does not exist: {roomId}.

Update E911 digital signage

Delete a Zoom Room