Zoom

Links

    Zoom API

    Getting access, Developing, Testing

    Back to Zoom

    Use Zoom Room Controls

    Use this API to control Zoom Rooms, including room check-in and check-out, mute on and off, incoming meeting request accept or decline, meeting join, leave, or end, room restart, and cancellation.

    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

    Rate Limit Label: Medium

    Input

    type: object properties: parameters: type: object properties: id: type: string example: qMOLddnySIGGVycz8aX_JQ description: Room ID required: - id title: Parameters data: oneOf: - required: - method properties: method: description: >- 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 is released from the scheduled meeting and made available for others to use. type: string example: zoomroom.check_in enum: - zoomroom.check_in params: type: object properties: calendar_id: description: >- The "id" field included in the [calendarList resource](https://developers.google.com/calendar/v3/reference/calendarList#resource). This field is only required if using Google Calendar for the event associated with the Zoom Room. Retrieve the value for this field by calling Google's [CalendarList:list API](https://developers.google.com/calendar/v3/reference/events/list). Applies to `zoomroom.check_in` and `zoomroom.check_out`. type: string example: [email protected] change_key: description: >- Represents the specific version of the calendar item. Retrieve it using Microsoft's [FindItem Operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). It refers to the `ChangeKey` field of the `ItemId` element included in the operation response. This field is required only for Microsoft Exchange or Office 365 calendar. Applies to `zoomroom.check_in` and `zoomroom.check_out`. type: string example: test_change_key event_id: description: >- (Required) The Unique Identifier of the calendar event associated with the Zoom Room. If using Microsoft Exchange for the calendar integration, retrieve the value of this field using Microsoft's [FindItem Operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). The value is the `Id` field of the `ItemId` element included in the operation response. If using the Google calendar integration for this event, call Google's [Events:list API](https://developers.google.com/calendar/v3/reference/events/list) to retrieve the value. The value is the `id` field in the [events resource](https://developers.google.com/calendar/v3/reference/events#resource). Applies to `zoomroom.check_in` and `zoomroom.check_out`. type: string example: ebrg2b87a6uu9c678qhvsiahsc resource_email: description: >- The [resource mailbox](https://support.microsoft.com/en-us/help/10063/creating-and-managing-resource-mailboxes-in-office-365) associated with the calendar. This field is only required for Microsoft Exchange / Office 365 Calendar. Applies to `zoomroom.check_in` and `zoomroom.check_out`. format: email type: string example: [email protected] type: object - required: - method properties: method: description: >- 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 is released from the scheduled meeting and made available for others to use. type: string example: zoomroom.check_out enum: - zoomroom.check_out params: type: object properties: calendar_id: description: >- The "id" field included in the [calendarList resource](https://developers.google.com/calendar/v3/reference/calendarList#resource). 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](https://developers.google.com/calendar/v3/reference/events/list). Applies to `zoomroom.check_in` and `zoomroom.check_out`. type: string example: [email protected] change_key: description: >- Represents the specific version of the calendar item. Retrieve it using Microsoft's [FindItem Operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). It refers to the `ChangeKey` field of the `ItemId` element included in the operation response. This field is required only for Microsoft Exchange or Office 365 calendar. Applies to `zoomroom.check_in` and `zoomroom.check_out`. type: string example: test_change_key event_id: description: >- (Required) The Unique Identifier of the calendar event associated with the Zoom Room. If using Microsoft Exchange for the calendar integration, retrieve the value of this field using Microsoft's [FindItem Operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). The value is the `Id` field of the `ItemId` element included in the operation response. If using the Google calendar integration for this event, call Google's [Events:list API](https://developers.google.com/calendar/v3/reference/events/list) to retrieve the value. The value is the `id` field in the [events resource](https://developers.google.com/calendar/v3/reference/events#resource). Applies to `zoomroom.check_in` and `zoomroom.check_out`. type: string example: ebrg2b87a6uu9c678qhvsiahsc resource_email: description: >- The [resource mailbox](https://support.microsoft.com/en-us/help/10063/creating-and-managing-resource-mailboxes-in-office-365) associated with the calendar. This field is only required for Microsoft Exchange / Office 365 Calendar. Applies to `zoomroom.check_in` and `zoomroom.check_out`. format: email type: string example: [email protected] type: object - required: - method properties: method: description: Mute the Zoom Rooms client. type: string example: zoomroom.mute enum: - zoomroom.mute type: object - required: - method properties: method: description: Unmute the Zoom Rooms client. type: string example: zoomroom.unmute enum: - zoomroom.unmute type: object - required: - method properties: method: description: Accept a meeting via the Zoom Rooms client. type: string example: zoomroom.meeting_accept enum: - zoomroom.meeting_accept type: object - required: - method properties: method: description: Decline a meeting via the Zoom Rooms client. type: string example: zoomroom.meeting_decline enum: - zoomroom.meeting_decline type: object - required: - method properties: method: description: Restart the Zoom Room client. type: string example: zoomroom.restart enum: - zoomroom.restart type: object - required: - method properties: method: description: Leave a meeting in progress via the Zoom Rooms client. type: string example: zoomroom.meeting_leave enum: - zoomroom.meeting_leave type: object - required: - method properties: method: description: Join a Zoom meeting from the Zoom Rooms client. type: string example: zoomroom.meeting_join enum: - zoomroom.meeting_join params: type: object properties: meeting_number: description: >- (Required) The meeting number. If this field has a value, join the meeting identified by this number. If this field does not have a value, start an [instant meeting](https://support.zoom.us/hc/en-us/articles/201362533-Instant-meetings-vs-scheduled-meetings). Applies to `zoomroom.meeting_join`. type: string example: '2022052323' passcode: description: The passcode to join the meeting. type: string example: A123456 force_accept: description: >- Whether to force a user to immediately join the meeting. If true, forces the user to leave any current meetings and immediately join the meeting passed in the `meeting_number` value (or instant meeting, if there is no value). type: boolean example: false type: object - required: - method properties: method: description: Invite a contact to use the Zoom Rooms client. type: string example: zoomroom.meeting_invite enum: - zoomroom.meeting_invite params: type: object properties: user_ids: description: >- (Required) A comma-separated list of callee user IDs, up to a maximum of 10 callees. type: array example: - 30R7kT7bTIKSNUFEuH_Qlg items: description: User ID type: string example: 30R7kT7bTIKSNUFEuH_Qlg type: object - required: - method properties: method: description: Cancel a meeting via the Zoom Rooms client. type: string example: zoomroom.meeting_cancel enum: - zoomroom.meeting_cancel params: type: object properties: meeting_topic: description: (Required) The meeting topic, up to 200 characters. type: string example: My zoom topic start_time: description: >- (Required) The meeting's start time in ISO date-time format. If you use this value with the timezone, you must also pass the timezone field. type: string example: '2022-05-20T12:00:00Z' duration: description: The scheduled meeting duration in minutes. type: integer example: 60 timezone: description: >- The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). Optional if the `start_time` value includes a timezone offset. Applies to `zoomroom.meeting_cancel` and `zoomroom.meeting_schedule`. type: string example: America/Los_Angeles type: object - required: - method properties: method: description: End a meeting in progress hosted by the Zoom Rooms client. type: string example: zoomroom.meeting_end enum: - zoomroom.meeting_end type: object - required: - method properties: method: description: Schedule a meeting using the Zoom Rooms client.. type: string example: zoomroom.meeting_schedule enum: - zoomroom.meeting_schedule params: type: object properties: passcode: description: The passcode to join the meeting. type: string example: A123456 meeting_topic: description: (Required) The meeting topic, up to 200 characters. type: string example: My zoom topic start_time: description: >- (Required) The meeting's start time in ISO date-time format. If you use this value with the timezone, you must also pass the timezone field. type: string example: '2022-05-20T12:00:00Z' duration: description: >- The scheduled meeting duration in minutes. Required for `zoomroom.meeting_cancel` and `zoomroom.meeting_schedule`. type: integer example: 60 timezone: description: >- The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). Optional if the `start_time` value includes a timezone offset. type: string example: America/Los_Angeles settings: type: object description: The meeting settings. Applies to`zoomroom.meeting_schedule`. properties: join_before_host: description: >- Whether to allow meeting participants to join before the meeting's host. Used only for scheduled or recurring meetings. type: boolean example: false type: object - required: - method properties: method: description: Start zoom room alert. type: string example: zoomroom.alarm_start enum: - zoomroom.alarm_start type: object - required: - method properties: method: description: Stop Zoom Room alert. type: string example: zoomroom.alarm_stop enum: - zoomroom.alarm_stop type: object title: Data