Please note that our Meeting API documentation has moved to the following URLs:

The following changes were released on February 28, 2022:

Added

Meetings

  • Get a meeting’s token

    • GET /v2/meetings/{meetingId}/token

  • Get a webinar’s token

    • GET /v2/webinars/{webinarId}/token

  • List device profiles

    • GET /v2/rooms/{roomId}/device_profiles

  • Create a device profile

    • POST /v2/rooms/{roomId}/device_profiles

  • Get device information

    • GET /v2/rooms/{roomId}/device_profiles/devices

  • Get a device profile

    • GET /v2/rooms/{roomId}/device_profiles/{deviceProfileId}

  • Update a device profile

    • PATCH /v2/rooms/{roomId}/device_profiles/{deviceProfileId}

  • Delete a device profile

    • DELETE /v2/rooms/{roomId}/device_profiles/{deviceProfileId}

Master account

  • Get a meeting’s token

    • GET /v2/accounts/{accountId}/meetings/{meetingId}/token

  • Get a webinar’s token

    • GET /v2/accounts/{accountId}/webinars/{webinarId}/token

  • List device profiles

    • GET /v2/accounts/{accountId}/rooms/{roomId}/device_profiles

  • Create a device profile

    • POST /v2/accounts/{accountId}/rooms/{roomId}/device_profiles

  • Get device information

    • GET /v2/accounts/{accountId}/rooms/{roomId}/device_profiles/devices

  • Get a device profile

    • GET /v2/accounts/{accountId}/rooms/{roomId}/device_profiles/{deviceProfileId}

  • Update a device profile

    • PATCH /v2/accounts/{accountId}/rooms/{roomId}/device_profiles/{deviceProfileId}

  • Delete a device profile

    • DELETE /v2/accounts/{accountId}/rooms/{roomId}/device_profiles/{deviceProfileId}

Enhancements

  • Added Video SDK account support to operate recording-related settings via access_token to the following APIs:

    • PATCH /v2/accounts/{accountId}/settings

    • GET /v2/accounts/{accountId}/settings

  • Added the ability to disable the description field for meetings and webinars to the following APIs:

    • POST /v2/users/{userId}/meetings

    • POST /v2/users/{userId}/webinars

    • GET /v2/users/{userId}/meetings

    • GET /v2/users/{userId}/webinars

    • PATCH /v2/meetings/{meetingId}

    • PATCH /v2/webinars/{webinarId}

    • GET /v2/meetings/{meetingId}

    • GET /v2/webinars/{webinarId}

  • The GET /webinars/{webinarId}/registrants/{registrantId} API now only returns attendee data.

  • Added the ability to increment and decrement the number of Zoom Phone licenses via the PUT /v2/accounts/{accountId}/plans/addons API.

  • Added support for the Zoom Phone add-on calling plans without a Zoom Phone calling plan to the POST /v2/accounts/{accountId}/plans/addons API’s Request Body.

  • Added support for adding multiple and subsequent Zoom Phone calling plans to an account to the POST /v2/accounts/{accountId}/plans/addons API.

  • Added support for the Zoom Phone calling plans and Pro Free Trial plans to the following APIs:

    • POST /v2/accounts/{accountId}/plans/addons

    • PUT /v2/accounts/{accountId}/plans/addons

    • PATCH /v2/accounts/{accountId}/plans/addons/status

  • Added the new audio_quality, video_quality, screen_share_quality response fields to the following APIs:

    • GET /v2/metrics/meetings

    • GET /v2/metrics/webinars

  • Added the new mc request parameter to the GET /v2/accounts/{accountId}/recordings API.

  • Added the new include_fields request parameter and the new duration_in_second response field to the following APIs:

    • GET /v2/archive_files

    • GET /v2/past_meetings/{meetingUUID}/archive_files

  • Added the new device_profile_id field to the following APIs:

    • GET /v2/rooms/{roomId}

    • PATCH /v2/rooms/{roomId}

  • Added the new disable_screen_sharing_for_host_meetings and disable_screen_sharing_for_in_meeting_guests fields to the following APIs:

    • PATCH /v2/accounts/{accountId}/settings

    • GET /v2/accounts/{accountId}/settings

    • PATCH /v2/groups/{groupId}/settings

    • GET /v2/groups/{groupId}/settings

    • PATCH /v2/users/{userId}/settings

    • GET /v2/users/{userId}/settings

    • PATCH /v2/accounts/{accountId}/lock_settings

    • GET /v2/accounts/{accountId}/lock_settings

    • PATCH /v2/groups/{groupId}/lock_settings

    • GET /v2/groups/{groupId}/lock_settings

  • Added the new subscription_end_time and account_number response fields to the GET /v2/accounts/{accountId} API.

  • Added the new group_id request parameter to the following APIs:

    • GET /v2/accounts/{accountId}/metrics/meetings

    • GET /v2/accounts/{accountId}/metrics/webinars

  • Added the new zoom_phone request parameter to the POST /v2/users API.

  • Added the new status response field to the following APIs:

    • GET /v2/report/meetings/{meetingId}/participants

    • GET /v2/report/webinars/{webinarId}/participants

Bug Fixes

  • Fixed an issue where the API and the UI were inconsistent with the meeting password length modification verification in the PATCH /v2/meetings/{meetingId}/recordings/settings API.

  • Fix an issue where users could not get a Virtual Background’s ID for the following APIs:

    • GET /v2/accounts/{accountId}/settings

    • GET /v2/users/{userId}/settings

    • GET /v2/groups/{groupId}/settings

  • Fixed an issue where two events were sent after executing the recover file operation in the following APIs:

    • PUT /v2/videosdk/sessions/{sessionId}/recordings

    • PUT /v2/videosdk/sessions/{sessionId}/recordings/{recordingId}

  • Fixed an issue where the following APIs would incorrectly allow for adding registrants to webinars with paid registration:

    • POST /v2/webinars/{webinarId}/registrants

    • POST /v2/webinars/{webinarId}/batch_registrants

  • Fixed an issue where member-level users received a "No Permission" error when attempting to start a cloud recording via the PATCH /v2/live_meetings/{meetingId}/events API.

  • Fixed an issue where the POST /v2/users/{userId}/meetings API’s jbh_time value did not use the user’s settings as the default value.

  • Fixed an issue where registering a manually-approved meeting with the auto_approved parameter set as true was not sending emails in the POST /v2/meetings/{meetingId}/registrants API.

  • Fixed an issue where free account users could not call the API.

  • Fixed an issue where the access token with the old Chat scope could not call the GET /v2/report/chat/sessions API.

  • Fixed an issue where the next_page_token would not return in some cases in the GET /v2/chat/users/{userId}/messages API.

  • Fixed an issue where the account owner could not update other users’ pronouns information in the PATCH /v2/users/{userId} API.