API Updates 03.22.21

The following changes were released on March 22, 2021.

New APIs and Webhooks

  • Added past webinar participants API.
    • GET /v2/past_webinars/{webinarId}/participants
  • Added batch webinar registration API.
    • POST /v2/webinars/{webinarId}/batch_registrants
  • Added archive files APIs. These APIs are only available to customers upon request. Learn more.
    • GET /v2/archive_files
    • GET /v2/accounts/{accountId}/archive_files
  • Added Zoom phone SIP trunk APIs.
    • GET /v2/phone/sip_trunk/trunks
    • GET /v2/accounts/{accountId}/phone/sip_trunk/trunks
    • POST /v2/accounts/{accountId}/phone/sip_trunk/trunks
    • PATCH /v2/accounts/{accountId}/phone/sip_trunk/trunks/{sipTrunkId
  • Added Zoom phone account settings API.
    • PATCH /v2/accounts/{accountId}/phone/settings
  • Added Zoom phone webhook events.
    • phone.generic_device_provision
    • phone.call_queue_joined
  • Added Zoom phone user setting APIs.
    • POST /v2/phone/users/{userId}/settings/{settingType}
    • PATCH /v2/phone/users/{userId}/settings/{settingType}
    • DELETE /v2/phone/users/{userId}/settings/{settingType}
    • POST /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
    • PATCH /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
    • DELETE /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
  • Added setting template APIs.
    • POST /v2/phone/setting_templates
    • GET /v2/phone/setting_templates
    • GET /v2/phone/setting_templates/{templateId}
    • PATCH /v2/phone/setting_templates/{templateId}
  • Added account setup API.
    • POST /v2/accounts/{accountId}/phone/setup
  • Added phone recording API.
    • GET /v2/phone/recordings

Enhancements

  • Added a new field(id) in Participant Waiting for Host event payload.

    • meeting.participant_jbh_waiting
  • Added a new field(ip_address_access_control) in account, group and user settings APIs.

    • GET /v2/accounts/{accountId}/settings
    • PATCH /v2/accounts/{accountId}/settings
    • GET /v2/accounts/{accountId}/lock_settings
    • PATCH /v2/accounts/{accountId}/lock_settings
    • GET /v2/groups/{groupId}/settings
    • PATCH /v2/groups/{groupId}/settings
    • GET /v2/groups/{groupId}/lock_settings
    • PATCH /v2/groups/{groupId}/lock_settings
    • GET /v2/users/{userId}/settings
    • PATCH /v2/users/{userId}/settings
  • Added a new field(archive) in account, group and user settings APIs.

    • GET /v2/accounts/{accountId}/lock_settings
    • PATCH /v2/accounts/{accountId}/lock_settings
    • GET /v2/groups/{groupId}/settings
    • PATCH /v2/groups/{groupId}/settings
    • GET /v2/groups/{groupId}/lock_settings
    • PATCH /groups/{groupId}/lock_settings
    • GET /v2/users/{userId}/settings
    • PATCH /v2/users/{userId}/settings
  • Added a new field(phone_numbers) in the user APIs.

    • GET /v2/users/{userId}
    • PATCH /v2/users/{userId}
  • Added a new field(host_id) in the telephone report API.

    • GET /v2/report/telephone
  • Added a new field(custom_keys) in the meeting APIs.

    • POST /v2/users/{userId}/meetings
    • GET /v2/meetings/{meetingId}
    • PATCH /v2/meetings/{meetingId}
  • Added a new field(source) in the meeting report API.

    • GET /v2/report/users/{userId}/meetings
  • Added a new field(custom_keys) in report and dashboard APIs.

    • GET /v2/report/users/{userId}/meetings
    • GET /v2/report/meetings/{meetingId}
    • GET /v2/report/webinars/{webinarId}
    • GET /v2/metrics/meetings
    • GET /v2/metrics/meetings/{meetingId}
    • GET /v2/metrics/webinars
    • GET /v2/metrics/webinars/{webinarId}
  • Added a new response field(voice_mail) in the user settings API.

    • GET /v2/phone/users/{userId}/settings
  • Added a new field(forwarded_by) in the following Phone webhooks.

    • phone.callee_ringing
    • phone.callee_answered
    • phone.callee_missed
    • phone.callee_ended
  • Added a new field(handup_result) in the following Phone webhooks.

    • phone.callee_missed
    • phone.callee_ended
    • phone.callee_rejected
    • phone.caller_ended
  • Added a new field(site_name) in the Phone emergency alert webhook.

    • phone.emergency_alert
  • Added new response fields(waiting_time, answer_start_time) and a query field(path) in account call logs API.

    • GET /v2/phone/call_logs
  • Added new response fields(forwarded_to, forwarded_by, accepted_by, outgoing_by, location) in user call logs API.

    • GET /v2/phone/users/{userId}/call_logs
  • Added a new plan type(4010 - Zoom Phone Power Pack) in Zoom Phone calling plans APIs.

    • GET /v2/phone/calling_plans
    • POST /v2/phone/users/{userId}/calling_plans
    • DELETE /v2/phone/users/{userId}/calling_plans/{type}
  • Added a new request field(phone_number) in user call logs API.

    • GET /v2/phone/users/{userId}/call_logs

Bug fixes

  • Fixed a bug where user’s email were not being returned in polling APIs.

    • GET /report/meetings/{meetingId}/polls
    • GET /past_meetings/{meetingId}/poll
  • Fixed the bug where the API did not accept Other as a valid value for the country field while registering a user for a webinar.

    • POST /v2/webinars/{webinarId}/registrants
  • Fixed a bug where PMI meetings did not support the approved_or_denied_countries_or_regions field.

    • POST /v2/users/{userId}/meetings
    • GET /v2/meetings/{meetingId}
    • PATCH /v2/meetings/{meetingId}
  • Fixed a bug where cancellation emails were being sent incorrectly to all webinar registrants.

    • PUT /v2/webinars/{webinarId}/registrants/status
  • Fixed a bug where the value of the department field was not being updated even after a successful update request.

    • PATCH /v2/users/{userId}
  • Fixed a bug where the value of the user_type field was being displayed in a language that was listed in user’s dashboard.

    • GET /metrics/meetings
  • Fixed a bug where user’s email were not being returned in polling APIs.

    • GET /report/meetings/{meetingId}/polls
    • GET /past_meetings/{meetingId}/poll

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

Thanks,
Tommy

1 Like

Has this been addressed in this release…?

Hey @murugan.raju ,

You can see the updated Zoom Phone APIs here:

Thanks,
Tommy

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.