The following changes were released on June 20, 2021.

New APIs and Webhooks

  • Chat Messages: Get a chat message.

    • GET /v2/chat/users/{userId}/messages/{messageId}

  • Meetings & Webinars: Create meeting’s & webinar’s invite links.

    • POST /v2/meetings/{meetingId}/invite_links

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

  • Webinars: Get live stream details, update a live stream, update live stream status.

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

    • PATCH /v2/webinars/{webinarId}/livestream

    • PATCH /v2/webinars/{webinarId}/livestream/status

  • Dashboards: Get chat metrics.

    • GET /v2/metrics/chat

  • Common Area Phones: Assign calling plans to common area phone.

    • POST /v2/phone/common_area_phones/{commonAreaPhoneId}/calling_plans

  • Common Area Phones: Unassign calling plans from common area phone.

    • DELETE /v2/phone/users/{userId}/calling_plans/{type}

  • Common Area Phones: Assign phone number to common area phone.

    • POST /v2/phone/common_area_phones/{commonAreaPhoneId}/phone_numbers

  • Common Area Phones: Unassign phone numbers from common area phone.

    • DELETE /v2/phone/common_area_phones/{commonAreaPhoneId}/phone_numbers/{phoneNumberId}

  • Phone: Batch add emergency service locations.

    • POST /v2/phone/batch_locations

Enhancements

  • New response fields (bot_message, file_id, file_name, file_size, download_url) in the List chat messages API.

    • GET /v2/chat/users/{userId}/messages

  • New field values (status = In_Calendar_Event / Presenting / In_A_Zoom_Meeting / On_A_Call) in the Update user’s presence status API.

    • PUT /v2/users/{userId}/presence_status

  • New request & response fields (jbh_time, block_user_domain, block_user_domain_list) in the Account/Group/User Settings APIs.

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

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

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

  • New request & response field (block_user_domain) in the Account/Group Settings APIs.

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

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

  • New response field (password) in the Recording API.

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

  • New request field (query_date_type) in the Telephone report API.

    • GET /v2/report/telephone

  • New user_info:read scope for the Get user info API.

    • GET /v2/users/me

  • Validation for the authentication_domains field in the Meeting & Webinar APIs, validation rule will follow Block users in specific domains from joining meetings and webinars options in the Account/Group/User settings.

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

    • PATCH /v2/meetings/{meetingId}

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

    • PATCH /v2/webinars/{webinarId}

  • New response fields (partner_sku, discount_rate, discount_percent) in the Billing APIs if the master account is a reseller account.

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

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

  • New request fields (purchase_order_number, contract_term, deal_registration_id) as the subscription_options for the billing subscribe APIs.

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

  • New fields (purchase_order_number, increasing_hosts) in the Billing APIs.

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

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

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

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

  • Billing operation logs for failure cases.

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

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

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

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

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

  • Security validation for the users’ APIs. Only the account administrator can change some of the user info if security options are enabled.

    • PATCH /v2/users/{userId}

      • 200 Only an account administrator can change a user’s name.

      • 200 Only an account administrator can change the host key.

      • 200 Only an account administrator can change a Personal Meeting ID (PMI).

      • 200 Only an account administrator can change a vanity name.

    • PUT /v2/users/{userId}/email

      • 200 Only an account administrator can change email.

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

      • 200 Only an account administrator can change a profile picture.

  • Validation for the Update user settings API.

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

      • 1204 You can’t enable the Webinar feature because you already have the Zoom Events Plus feature.

  • Add required for the page_url field in the update meeting live stream API.

    • PATCH /v2/meetings/{meetingId}/livestream

    • PATCH /v2/webinars/{webinarId}/livestream

  • New response fields (phone_numbers, calling_plans, provision_template, policy, secondary_outbound_proxy) in the Retrieve a common area phone API.

    • GET /v2/phone/common_area_phones/{commonAreaPhoneId}

  • New response fields (phone_numbers, calling_plans) in the List common area phones API.

    • GET /v2/phone/common_area_phones

  • New request fields (provision_template_id) in the Add Common Area Phone API.

    • POST /v2/phone/common_area_phones

  • New request fields (policy, provision_template_id) in the Update Common Area Phone API.

    • PATCH /v2/phone/common_area_phones/{commonAreaPhoneId}

  • New response fields (device_public_ip, device_public_ip) in Retrieve Account’s Call Logs API(when show_device_ip_for_call_log switch enabled).

    • GET /v2/phone/call_logs

  • New response fields (device_public_ip, device_public_ip) in Retrieve Call Log Details API(when show_device_ip_for_call_log switch enabled).

    • GET /v2/phone/call_logs/{callLogId}

  • New request field (show_device_ip_for_call_log) in Update Account Setting API.

    • PATCH /v2/phone/settings

  • New response field (show_device_ip_for_call_log) in Get Account Setting API.

    • GET /v2/phone/settings

  • New request field (sip_group_id) in the Add BYOC Phone Number API.

    • POST /v2/phone/byoc_numbers

  • New response fields (carrier, sip_group) in the Retrieve a Phone Number Detail API.

    • GET /v2/phone/numbers/{numberId}

  • New request field (sip_group_id) in the Update Phone Number API.

    • PATCH /v2/phone/numbers/{numberId}

  • New response fields (carrier, sip_group) in the List Phone Numbers API.

    • GET /v2/phone/numbers

  • New response field (secondary_outbound_proxy) in the Retrieve a Device API.

    • GET /v2/phone/devices/{deviceId}

  • New response field (devices) in the 400 error response of Add Device API.

    • POST /v2/phone/devices

Bug Fixes

  • Fixed the bug that the meetings scheduled with PMI or no fixed time still return the value of the jbh_time field.

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

    • PATCH /v2/meetings/{meetingId}

  • Fixed the bug that the schedule_for parameter can be set for the instant meetings.

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

    • PATCH /v2/meetings/{meetingId}

  • Fixed the bug that the webhook events trigger with unchanged field (files).

    • user.settings_update

    • account.settings_updated

  • Fixed the bug that free accounts can have paid users.

    • GET /v2/users

    • GET /v2/users/{userId}

  • Allow Admin without a phone license to list account level phone recordings.

  • Fixed receive_call value issue in GET v2/phone/call_queues/{callQueueId}.

  • Fixed call metrics “internal” direction issue for GET phone/metrics/call_logs.