API Updates 05.23.21

Announcements New Releases
1

The following changes were released on May 23, 2021.

Additions

  • Added new API to mark chat messages read or unread.
    • PATCH /v2/chat/users/{userId}/messages/{messageId}/status
  • Added new API to getting a meeting with archived files.
    • GET /v2/past_meetings/{meetingUUId}/archive_files
  • Published the Retrieve Call Log Details API. This API was available but not documented.
    • GET /v2/phone/call_logs/{callLogId}

Enhancements

  • Added new error message in the Delete User API.
    • DELETE /v2/users/{userId}
      • 200 Unable to delete this deactivated user. Please contact Zoom support team for more information.
  • Added new response field ( signaled_number ) in the Get Telephone Report API.
    • GET /v2/report/telephone
  • Added new response field ( failover ) in the Get Meeting/Webinar Participant Report APIs.
    • GET /v2/report/meetings/{meetingId}/participants
    • GET /v2/report/webinars/{webinarId}/participants
  • Added new request field ( tracking_source_id ) in the List webinar registrants API.
    • GET /v2/webinars/{webinarId}/registrants
  • Return live instant meetings in the List meetings API.
    • GET /v2/users/{userId}/meetings
  • Added new fields ( email_language , panelists_invitation_email_notification , attendees_and_panelists_reminder_email_notification , follow_up_attendees_email_notification , follow_up_absentees_email_notification ) in the webinar APIs.
    • POST /v2/users/{userId}/webinars
    • GET /v2/webinars/{webinarId}
    • PATCH /v2/webinars/{webinarId}
  • Added new query parameter ( query_data_type ) in Recording API.
    • GET /v2/archive_files
    • GET /v2/accounts/{accountId}/archive_files
  • Added new fields ( chat_with_sender_email , cc_transcript_file ) in the Account/Group Settings APIs.
    • GET /v2/accounts/{accountId}/settings
    • PATCH /v2/accounts/{accountId}/settings
    • GET /v2/groups/{groupId}/settings
    • PATCH /v2/groups/{groupId}/settings
  • Added new field value ( meeting_authentication , type = enforce_login_with_same_account ) in the Account/Group/User Settings APIs.
    • GET /v2/accounts/{accountId}/settings
    • PATCH /v2/accounts/{accountId}/settings
    • GET /v2/groups/{groupId}/settings
    • GET /v2/users/{userId}/settings
  • Added new query parameter ( include_fields = download_access_token ) in the Recording API.
    • GET /v2/meetings/{meetingId}/recordings
  • Added new response field ( download_access_token ) in the Recording API.
    • GET /v2/meetings/{meetingId}/recordings
  • Added new fields ( recording_type , recording_id , call_id , call_type ) in the List Account’s Call Logs APIs.
    • GET /v2/phone/call_logs
    • GET /v2/accounts/{accountId}/phone/call_logs
  • Added new field ( call_type ) in the List User’s Call Logs APIs.
    • GET /v2/phone/users/{userId}/call_logs
    • GET /v2/accounts/{accountId}/phone/users/{userId}/call_logs
  • Added new field ( call_type ) in phone call log completed wehhook events.
    • phone.caller_call_log_completed
    • phone.callee_call_log_completed
  • Added new response field ( forward_to ) in the Retrieve Call Log Details API.
    • GET /v2/phone/call_logs/{callLogId}
  • Added new response field ( owner ) in the Retrieve Account’s Call Logs API.
    • GET /v2/phone/call_logs
  • The path parameter commonAreaPhoneId supports both commonAreaPhoneId and macAddress in the Common Area Phone APIs.
    • PATCH /v2/phone/common_area_phones/{commonAreaPhoneId}
    • DELETE /v2/phone/common_area_phones/{commonAreaPhoneId}
    • GET /v2/phone/common_area_phone/{commonAreaPhoneId}
  • The path parameters ( from , to ) supports both date and time(in yyyy-MM-dd'T'HH:mm:ss'Z' format) in the Retrieve Account’s Recordings API.
    • GET /v2/phone/recordings
  • The path parameter callLogId supports both call log id and call id in the Retrieve Call Log Details API.
    • GET /v2/phone/call_logs/{callLogId}
  • Added new parameter ( site_id ) in the Retrieve Account’s Call Logs API.
    • GET /v2/phone/call_logs
  • Added new response field ( shared_line ) in the Get Device Details API.
    • GET /v2/phone/devices/{deviceId}
  • Changed documentation display name of Get call log details API to (Get call details from call log). Did not change the endpoint name.
    • GET /phone/metrics/call_logs/{call_id}

Bug fixes

  • Fixed the bug where user email is always returned in lower case in the User API.
    • GET /v2/users
    • GET /v2/users/{userId}
  • Fixed the bug where the user ID is returned as date & time in the Get Meeting/Webinar Participant Report APIs when failover happens.
    • GET /v2/report/meetings/{meetingId}/participants
    • GET /v2/report/webinars/{webinarId}/participants
  • Fixed the bug where the city field is not returned in the Get Meeting/Webinar APIs.
    • GET /v2/meetings/{meetingId}
    • GET /v2/webinars/{webinarId}
  • Fixed the bug where meeting_authentication does not return true when the option ( Only authenticated users can join meetings ) is locked on in the account settings.
    • GET /v2/meetings/{meetingId}
    • GET /v2/webinars/{webinarId}
  • Fixed the bug where the field ( user_type ) omits the webinar type and the large meeting type for List Webinars Dashboards API.
    • GET /v2/metrics/webinars
  • Fixed the bug where updating minimum password length overwrites 2FA field in the Update Account Settings API.
    • PATCH /v2/accounts/{accountId}/settings
  • Fixed the bug where the user.settings_updated webhook event doesn’t fire for Recording settings.
    • user.settings_updated
  • Fixed the bug where clients can’t receive the recording.registration_created event when registering for an on-demand webinar.
    • recording.registration_created
  • Blocking billing APIs throw an error message for the bulk license master account.
    • 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
    • PATCH /v2/accounts/{accountId}/plans/base/status
    • PATCH /v2/accounts/{accountId}/plans/addons/status
  • Changed documentation display name of Get call log details API to Get call details from call log. Did not change endpoint name.
    • GET /phone/metrics/call_logs/{call_id}

You can also see the update listed on our Changelog: https://marketplace.zoom.us/docs/changelog

Thanks,
Tommy

2

thank you so much for informing us. now I can change the setting of my project tesco duplicate bill. Once again thank you so much

3

Awesome now my event owners can apply reminder and follow up emails in different languages. This is great!

5

You are welcome! :slight_smile:

-Tommy