zoom_us

ZoomUs - the Ruby gem for the Zoom API

The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/. For instance you can list all users on an account via https://api.zoom.us/v2/users/.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0.0
  • Package version: 0.1.1
  • Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://developer.zoom.us/

Installation

Build a gem

To build the Ruby code into a gem:

gem build zoom_us.gemspec

Then either install the gem locally:

gem install ./zoom_us-0.1.1.gem

(for development, run gem install --dev ./zoom_us-0.1.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'zoom_us', '~> 0.1.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'zoom_us', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'zoom_us'

# Setup authorization
ZoomUs.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ZoomUs::AccountsApi.new

 = 'account_id_example' # String | The account ID.


begin
  #Get a Sub Account
  result = api_instance.()
  p result
rescue ZoomUs::ApiError => e
  puts "Exception when calling AccountsApi->account: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.zoom.us/v2

Class Method HTTP request Description
ZoomUs::AccountsApi account GET /accounts/accountId Get a Sub Account
ZoomUs::AccountsApi account_create POST /accounts Create a Sub Account
ZoomUs::AccountsApi account_disassociate DELETE /accounts/accountId Disassociate a Sub Account
ZoomUs::AccountsApi account_managed_domain GET /accounts/accountId/managed_domains Get Managed Domains
ZoomUs::AccountsApi account_options_update PATCH /accounts/accountId/options Update Options
ZoomUs::AccountsApi account_settings GET /accounts/accountId/settings Get Settings
ZoomUs::AccountsApi account_settings_update PATCH /accounts/accountId/settings Update Settings
ZoomUs::AccountsApi account_trusted_domain GET /accounts/accountId/trusted_domains Get Trusted Domains
ZoomUs::AccountsApi accounts GET /accounts List Sub Accounts
ZoomUs::AccountsApi get_account_lock_settings GET /accounts/accountId/lock_settings Get Locked Settings
ZoomUs::AccountsApi update_account_lock_settings PATCH /accounts/accountId/lock_settings Update Locked Settings
ZoomUs::AccountsApi update_account_owner PUT /accounts/accountId/owner Update the Account Owner
ZoomUs::BillingApi account_billing GET /accounts/accountId/billing Get Billing Information
ZoomUs::BillingApi account_billing_update PATCH /accounts/accountId/billing Update Billing Information
ZoomUs::BillingApi account_plan_addon_cancel PATCH /accounts/accountId/plans/addons/status Cancel Additional Plans
ZoomUs::BillingApi account_plan_addon_create POST /accounts/accountId/plans/addons Add an Additional Plan
ZoomUs::BillingApi account_plan_addon_update PUT /accounts/accountId/plans/addons Update an Additional Plan
ZoomUs::BillingApi account_plan_base_delete PATCH /accounts/accountId/plans/base/status Cancel Base Plan
ZoomUs::BillingApi account_plan_base_update PUT /accounts/accountId/plans/base Update a Base Plan
ZoomUs::BillingApi account_plan_create POST /accounts/accountId/plans Subscribe to Plans
ZoomUs::BillingApi account_plans GET /accounts/accountId/plans Get Plan Information
ZoomUs::BillingApi get_plan_usage GET /accounts/accountId/plans/usage Get Plan Usage
ZoomUs::ChatChannelsApi create_channel POST /chat/users/me/channels Create a Channel
ZoomUs::ChatChannelsApi delete_channel DELETE /chat/channels/channelId Delete a Channel
ZoomUs::ChatChannelsApi get_channel GET /chat/channels/channelId Get a Channel
ZoomUs::ChatChannelsApi get_channels GET /chat/users/me/channels List User's Channels
ZoomUs::ChatChannelsApi invite_channel_members POST /chat/channels/channelId/members Invite Channel Members
ZoomUs::ChatChannelsApi join_channel POST /chat/channels/channelId/members/me Join a Channel
ZoomUs::ChatChannelsApi leave_channel DELETE /chat/channels/channelId/members/me Leave a Channel
ZoomUs::ChatChannelsApi list_channel_members GET /chat/channels/channelId/members List Channel Members
ZoomUs::ChatChannelsApi remove_a_channel_member DELETE /chat/channels/channelId/members/memberId Remove a Member
ZoomUs::ChatChannelsApi update_channel PATCH /chat/channels/channelId Update a Channel
ZoomUs::ChatMessagesApi delete_chat_message DELETE /chat/users/me/messages/messageId Delete a Message
ZoomUs::ChatMessagesApi edit_message PUT /chat/users/me/messages/messageId Update a Message
ZoomUs::ChatMessagesApi get_chat_messages GET /chat/users/userId/messages List User's Chat Messages
ZoomUs::ChatMessagesApi senda_chat_message POST /chat/users/me/messages Send a Chat Message
ZoomUs::ChatbotMessagesApi delete_a_chatbot_message DELETE /im/chat/messages/message_id Delete a Chatbot Message
ZoomUs::ChatbotMessagesApi edit_chatbot_message PUT /im/chat/messages/message_id Edit a Chatbot Message
ZoomUs::ChatbotMessagesApi sendchatbot POST /im/chat/messages Send Chatbot Messages
ZoomUs::CloudRecordingApi get_account_cloud_recording GET /accounts/accountId/recordings List Recordings of an Account
ZoomUs::CloudRecordingApi meeting_recording_registrant_create POST /meetings/meetingId/recordings/registrants Create a Recording Registrant
ZoomUs::CloudRecordingApi meeting_recording_registrant_status PUT /meetings/meetingId/recordings/registrants/status Update Recording Registrant's Status
ZoomUs::CloudRecordingApi meeting_recording_registrants GET /meetings/meetingId/recordings/registrants List Recording Registrants
ZoomUs::CloudRecordingApi recording_delete DELETE /meetings/meetingId/recordings Delete Meeting Recordings
ZoomUs::CloudRecordingApi recording_delete_one DELETE /meetings/meetingId/recordings/recordingId Delete a Meeting Recording File
ZoomUs::CloudRecordingApi recording_get GET /meetings/meetingId/recordings Get Meeting Recordings
ZoomUs::CloudRecordingApi recording_registrant_question_update PATCH /meetings/meetingId/recordings/registrants/questions Update Registration Questions
ZoomUs::CloudRecordingApi recording_registrants_questions_get GET /meetings/meetingId/recordings/registrants/questions Get Registration Questions
ZoomUs::CloudRecordingApi recording_setting_update GET /meetings/meetingId/recordings/settings Get Meeting Recording Settings
ZoomUs::CloudRecordingApi recording_settings_update PATCH /meetings/meetingId/recordings/settings Update Meeting Recording Settings
ZoomUs::CloudRecordingApi recording_status_update PUT /meetings/meetingId/recordings/status Recover Meeting Recordings
ZoomUs::CloudRecordingApi recording_status_update_one PUT /meetings/meetingId/recordings/recordingId/status Recover a Single Recording
ZoomUs::CloudRecordingApi recordings_list GET /users/userId/recordings List All Recordings
ZoomUs::CommonAreaPhonesApi add_common_area_phone POST /phone/common_area_phones Add a Common Area Phone
ZoomUs::CommonAreaPhonesApi delete_common_area_phone DELETE /phone/common_area_phone/commonAreaPhoneId Delete a Common Area Phone
ZoomUs::CommonAreaPhonesApi get_a_common_area_phone GET /phone/common_area_phone/commonAreaPhoneId Get Common Area Phone Details
ZoomUs::CommonAreaPhonesApi list_common_area_phones GET /phone/common_area_phones List Common Area Phones
ZoomUs::CommonAreaPhonesApi update_common_area_phone PATCH /phone/common_area_phone/commonAreaPhoneId Update Common Area Phone
ZoomUs::ContactsApi get_user_contact GET /chat/users/me/contacts/contactId Get User's Contact Details
ZoomUs::ContactsApi get_user_contacts GET /chat/users/me/contacts List User's Contacts
ZoomUs::ContactsApi search_company_contacts GET /contacts Search Company Contacts
ZoomUs::DashboardsApi dashboard_client_feedback GET /metrics/client/feedback List Zoom Meetings Client Feedbacks
ZoomUs::DashboardsApi dashboard_client_feedback_detail GET /metrics/client/feedback/feedbackId Get Zoom Meetings Client Feedback
ZoomUs::DashboardsApi dashboard_crc GET /metrics/crc Get CRC Port Usage
ZoomUs::DashboardsApi dashboard_im GET /metrics/im Get IM Metrics
ZoomUs::DashboardsApi dashboard_issue_detail_zoom_room GET /metrics/issues/zoomrooms/zoomroomId Get Issues of Zoom Rooms
ZoomUs::DashboardsApi dashboard_issue_zoom_room GET /metrics/issues/zoomrooms Get Top 25 Zoom Rooms with Issues
ZoomUs::DashboardsApi dashboard_meeting_detail GET /metrics/meetings/meetingId Get Meeting Details
ZoomUs::DashboardsApi dashboard_meeting_participant_qos GET /metrics/meetings/meetingId/participants/participantId/qos Get Meeting Participant QOS
ZoomUs::DashboardsApi dashboard_meeting_participant_share GET /metrics/meetings/meetingId/participants/sharing Get Sharing/Recording Details of Meeting Participants
ZoomUs::DashboardsApi dashboard_meeting_participants GET /metrics/meetings/meetingId/participants List Meeting Participants
ZoomUs::DashboardsApi dashboard_meeting_participants_qos GET /metrics/meetings/meetingId/participants/qos List Meeting Participants QOS
ZoomUs::DashboardsApi dashboard_meetings GET /metrics/meetings List Meetings
ZoomUs::DashboardsApi dashboard_webinar_detail GET /metrics/webinars/webinarId Get Webinar Details
ZoomUs::DashboardsApi dashboard_webinar_participant_qos GET /metrics/webinars/webinarId/participants/participantId/qos Get Webinar Participant QOS
ZoomUs::DashboardsApi dashboard_webinar_participant_share GET /metrics/webinars/webinarId/participants/sharing Get Sharing/Recording Details of Webinar Participants
ZoomUs::DashboardsApi dashboard_webinar_participants GET /metrics/webinars/webinarId/participants Get Webinar Participants
ZoomUs::DashboardsApi dashboard_webinar_participants_qos GET /metrics/webinars/webinarId/participants/qos List Webinar Participant QOS
ZoomUs::DashboardsApi dashboard_webinars GET /metrics/webinars List Webinars
ZoomUs::DashboardsApi dashboard_zoom_room GET /metrics/zoomrooms/zoomroomId Get Zoom Rooms Details
ZoomUs::DashboardsApi dashboard_zoom_room_issue GET /metrics/zoomrooms/issues Get Top 25 issues of Zoom Rooms
ZoomUs::DashboardsApi dashboard_zoom_rooms GET /metrics/zoomrooms List Zoom Rooms
ZoomUs::DashboardsApi list_meeting_satisfaction GET /metrics/client/satisfaction List Client Meeting Satisfaction
ZoomUs::DevicesApi device_create POST /h323/devices Create a H.323/SIP Device
ZoomUs::DevicesApi device_delete DELETE /h323/devices/deviceId Delete a H.323/SIP Device
ZoomUs::DevicesApi device_list GET /h323/devices List H.323/SIP Devices
ZoomUs::DevicesApi device_update PATCH /h323/devices/deviceId Update a H.323/SIP Device
ZoomUs::GroupsApi get_group_lock_settings GET /groups/groupId/lock_settings Get Locked Settings
ZoomUs::GroupsApi get_group_settings GET /groups/groupId/settings Get a Group's Settings
ZoomUs::GroupsApi group GET /groups/groupId Get a Group
ZoomUs::GroupsApi group_create POST /groups Create a Group
ZoomUs::GroupsApi group_delete DELETE /groups/groupId Delete a Group
ZoomUs::GroupsApi group_locked_settings PATCH /groups/groupId/lock_settings Update Locked Settings
ZoomUs::GroupsApi group_members GET /groups/groupId/members List Group Members
ZoomUs::GroupsApi group_members_create POST /groups/groupId/members Add Group Members
ZoomUs::GroupsApi group_members_delete DELETE /groups/groupId/members/memberId Delete a Group Member
ZoomUs::GroupsApi group_update PATCH /groups/groupId Update a Group
ZoomUs::GroupsApi groups GET /groups List Groups
ZoomUs::GroupsApi update_a_group_member PATCH /groups/groupId/members/memberId Update a Group Member
ZoomUs::GroupsApi update_group_settings PATCH /groups/groupId/settings Update a Group's Settings
ZoomUs::IMChatApi im_chat_messages GET /im/chat/sessions/sessionId Retrieve IM Chat Messages
ZoomUs::IMChatApi im_chat_sessions GET /im/chat/sessions Get IM Chat Sessions
ZoomUs::IMChatApi listimmessages GET /im/users/userId/chat/messages Get User’s IM Messages
ZoomUs::IMChatApi sendimmessages POST /im/users/me/chat/messages Send IM messages
ZoomUs::IMGroupsApi im_group GET /im/groups/groupId Retrieve an IM Directory Group
ZoomUs::IMGroupsApi im_group_create POST /im/groups Create an IM Directory Group
ZoomUs::IMGroupsApi im_group_delete DELETE /im/groups/groupId Delete an IM Directory Group
ZoomUs::IMGroupsApi im_group_members GET /im/groups/groupId/members List IM Directory Group Members
ZoomUs::IMGroupsApi im_group_members_create POST /im/groups/groupId/members Add IM Directory Group Members
ZoomUs::IMGroupsApi im_group_members_delete DELETE /im/groups/groupId/members/memberId Delete an IM Directory Group Member
ZoomUs::IMGroupsApi im_group_update PATCH /im/groups/groupId Update an IM Directory Group
ZoomUs::IMGroupsApi im_groups GET /im/groups List IM Directory Groups
ZoomUs::MeetingsApi list_past_meeting_files GET /past_meetings/meetingId/files List Past Meeting Files
ZoomUs::MeetingsApi list_past_meeting_polls GET /past_meetings/meetingId/polls List Past Meeting's Poll Results
ZoomUs::MeetingsApi meeting GET /meetings/meetingId Get a Meeting
ZoomUs::MeetingsApi meeting_create POST /users/userId/meetings Create a Meeting
ZoomUs::MeetingsApi meeting_delete DELETE /meetings/meetingId Delete a Meeting
ZoomUs::MeetingsApi meeting_invitation GET /meetings/meetingId/invitation Get Meeting Invitation
ZoomUs::MeetingsApi meeting_live_stream_status_update PATCH /meetings/meetingId/livestream/status Update Live Stream Status
ZoomUs::MeetingsApi meeting_live_stream_update PATCH /meetings/meetingId/livestream Update Live Stream
ZoomUs::MeetingsApi meeting_poll_create POST /meetings/meetingId/polls Create a Meeting Poll
ZoomUs::MeetingsApi meeting_poll_delete DELETE /meetings/meetingId/polls/pollId Delete a Meeting Poll
ZoomUs::MeetingsApi meeting_poll_get GET /meetings/meetingId/polls/pollId Get a Meeting Poll
ZoomUs::MeetingsApi meeting_poll_update PUT /meetings/meetingId/polls/pollId Update a Meeting Poll
ZoomUs::MeetingsApi meeting_polls GET /meetings/meetingId/polls List Meeting Polls
ZoomUs::MeetingsApi meeting_registrant_create POST /meetings/meetingId/registrants Add Meeting Registrant
ZoomUs::MeetingsApi meeting_registrant_question_update PATCH /meetings/meetingId/registrants/questions Update Registration Questions
ZoomUs::MeetingsApi meeting_registrant_status PUT /meetings/meetingId/registrants/status Update Meeting Registrant Status
ZoomUs::MeetingsApi meeting_registrants GET /meetings/meetingId/registrants List Meeting Registrants
ZoomUs::MeetingsApi meeting_registrants_questions_get GET /meetings/meetingId/registrants/questions List Registration Questions
ZoomUs::MeetingsApi meeting_status PUT /meetings/meetingId/status Update Meeting Status
ZoomUs::MeetingsApi meeting_update PATCH /meetings/meetingId Update a Meeting
ZoomUs::MeetingsApi meetings GET /users/userId/meetings List Meetings
ZoomUs::MeetingsApi past_meeting_details GET /past_meetings/meetingUUID Get Past Meeting Details
ZoomUs::MeetingsApi past_meeting_participants GET /past_meetings/meetingUUID/participants Get Past Meeting Participants
ZoomUs::MeetingsApi past_meetings GET /past_meetings/meetingId/instances List Ended Meeting Instances
ZoomUs::PACApi user_pa_cs GET /users/userId/pac List a User's PAC Accounts
ZoomUs::PhoneApi account_call_logs GET /phone/call_logs Get Account's Call Logs
ZoomUs::PhoneApi assign_calling_plan POST /phone/users/userId/calling_plans Assign Calling Plan to a User
ZoomUs::PhoneApi assign_phone_number POST /phone/users/userId/phone_numbers Assign Phone Number to User
ZoomUs::PhoneApi change_main_company_number PUT /phone/company_number Change Main Company Number
ZoomUs::PhoneApi get_phone_number_details GET /phone/numbers/numberId Get Phone Number Details
ZoomUs::PhoneApi list_account_phone_numbers GET /phone/numbers List Phone Numbers
ZoomUs::PhoneApi list_calling_plans GET /phone/calling_plans List Calling Plans
ZoomUs::PhoneApi list_phone_users GET /phone/users List Phone Users
ZoomUs::PhoneApi phone_user GET /phone/users/userId Get User's Profile
ZoomUs::PhoneApi phone_user_call_logs GET /phone/users/userId/call_logs Get User's Call Logs
ZoomUs::PhoneApi phone_user_recordings GET /phone/users/userId/recordings Get User's Recordings
ZoomUs::PhoneApi phone_user_settings GET /phone/users/userId/settings Get User's Settings
ZoomUs::PhoneApi phone_user_voice_mails GET /phone/users/userId/voice_mails Get User's Voicemails
ZoomUs::PhoneApi unassign_calling_plan DELETE /phone/users/userId/calling_plans/type Unassign User's Calling Plan
ZoomUs::PhoneApi unassign_phone_number DELETE /phone/users/userId/phone_numbers/phoneNumberId Unassign User's Phone Number
ZoomUs::PhoneApi update_user_profile PATCH /phone/users/userId Update User's Profile
ZoomUs::PhoneAutoReceptionistsApi assign_phone_numbers_auto_receptionist POST /phone/auto_receptionists/autoReceptionistId/phone_numbers Assign Phone Numbers
ZoomUs::PhoneAutoReceptionistsApi unassign_a_phone_num_auto_receptionist DELETE /phone/auto_receptionists/autoReceptionistId/phone_numbers/phoneNumberId Unassign a Phone Number
ZoomUs::PhoneAutoReceptionistsApi unassign_all_phone_nums_auto_receptionist DELETE /phone/auto_receptionists/autoReceptionistId/phone_numbers Unassign all Phone Numbers
ZoomUs::PhoneAutoReceptionistsApi update_auto_receptionist PATCH /phone/auto_receptionists/autoReceptionistId Update Auto Receptionist Details
ZoomUs::PhoneBlockedListApi add_anumber_to_blocked_list POST /phone/blocked_list Create a Blocked List
ZoomUs::PhoneBlockedListApi delete_a_blocked_list DELETE /phone/blocked_list/blockedListId Delete a Blocked List
ZoomUs::PhoneBlockedListApi get_a_blocked_list GET /phone/blocked_list/blockedListId Get Blocked List Details
ZoomUs::PhoneBlockedListApi list_blocked_list GET /phone/blocked_list List Blocked Lists
ZoomUs::PhoneBlockedListApi update_blocked_list PATCH /phone/blocked_list/blockedListId Update a Blocked List
ZoomUs::PhoneCallQueuesApi add_members_to_call_queue POST /phone/call_queues/callQueueId/members Add Members to a Call Queue
ZoomUs::PhoneCallQueuesApi assign_phone_to_call_queue POST /phone/call_queues/callQueueId/phone_numbers Assign Numbers to a Call Queue
ZoomUs::PhoneCallQueuesApi change_call_queue_manager PUT /phone/call_queues/callQueueId/manager Change Call Queue Manager
ZoomUs::PhoneCallQueuesApi create_call_queue POST /phone/call_queues Create a Call Queue
ZoomUs::PhoneCallQueuesApi delete_a_call_queue DELETE /phone/call_queues/callQueueId Delete a Call Queue
ZoomUs::PhoneCallQueuesApi get_a_call_queue GET /phone/call_queues/callQueueId Get Call Queue Details
ZoomUs::PhoneCallQueuesApi list_call_queues GET /phone/call_queues List Call Queues
ZoomUs::PhoneCallQueuesApi un_assign_phone_num_call_queue DELETE /phone/call_queues/callQueueId/phone_numbers/phoneNumberId Unassign a Phone Number
ZoomUs::PhoneCallQueuesApi unassign_a_phone_num_call_queue DELETE /phone/call_queues/callQueueId/phone_numbers Unassign all Phone Numbers
ZoomUs::PhoneCallQueuesApi unassign_all_members DELETE /phone/call_queues/callQueueId/members Unassign all Members
ZoomUs::PhoneCallQueuesApi unassign_member_from_call_queue DELETE /phone/call_queues/callQueueId/members/memberId Unassign a Member
ZoomUs::PhoneCallQueuesApi update_call_queue PATCH /phone/call_queues/callQueueId Update Call Queue Details
ZoomUs::PhoneDevicesApi add_phone_device POST /phone/devices Add a Device
ZoomUs::PhoneDevicesApi delete_a_device DELETE /phone/devices/deviceId Delete a Device
ZoomUs::PhoneDevicesApi get_a_device GET /phone/devices/deviceId Get Device Details
ZoomUs::PhoneDevicesApi list_phone_devices GET /phone/devices List Devices
ZoomUs::PhoneDevicesApi update_a_device PATCH /phone/devices/deviceId Update a Device
ZoomUs::PhoneSiteApi create_phone_site POST /phone/sites Create a Phone Site
ZoomUs::PhoneSiteApi delete_phone_site DELETE /phone/sites/siteId Delete a Phone Site
ZoomUs::PhoneSiteApi get_a_site GET /phone/sites/siteId Get Phone Site Details
ZoomUs::PhoneSiteApi list_phone_sites GET /phone/sites List Phone Sites
ZoomUs::PhoneSiteApi update_site_details PATCH /phone/sites/siteId Update Phone Site Details
ZoomUs::ReportsApi get_billing_invoices_reports GET /report/billing/invoices Get Billing Invoice Reports
ZoomUs::ReportsApi get_billing_report GET /report/billing Get Billing Reports
ZoomUs::ReportsApi report_cloud_recording GET /report/cloud_recording Get Cloud Recording Usage Report
ZoomUs::ReportsApi report_daily GET /report/daily Get Daily Usage Report
ZoomUs::ReportsApi report_meeting_details GET /report/meetings/meetingId Get Meeting Detail Reports
ZoomUs::ReportsApi report_meeting_participants GET /report/meetings/meetingId/participants Get Meeting Participant Reports
ZoomUs::ReportsApi report_meeting_polls GET /report/meetings/meetingId/polls Get Meeting Poll Reports
ZoomUs::ReportsApi report_meetings GET /report/users/userId/meetings Get Meeting Reports
ZoomUs::ReportsApi report_operation_logs GET /report/operationlogs Get Operation Logs Report
ZoomUs::ReportsApi report_sign_in_sign_out_activities GET /report/activities Get Sign In / Sign Out Activity Report
ZoomUs::ReportsApi report_telephone GET /report/telephone Get Telephone Reports
ZoomUs::ReportsApi report_users GET /report/users Get Active/Inactive Host Reports
ZoomUs::ReportsApi report_webinar_details GET /report/webinars/webinarId Get Webinar Detail Reports
ZoomUs::ReportsApi report_webinar_participants GET /report/webinars/webinarId/participants Get Webinar Participant Reports
ZoomUs::ReportsApi report_webinar_polls GET /report/webinars/webinarId/polls Get Webinar Poll Reports
ZoomUs::ReportsApi report_webinar_qa GET /report/webinars/webinarId/qa Get Webinar Q&A Report
ZoomUs::RolesApi add_role_members POST /roles/roleId/members Assign a Role to Members
ZoomUs::RolesApi create_role POST /roles Create a Role
ZoomUs::RolesApi delete_role DELETE /roles/roleId Delete a Role
ZoomUs::RolesApi get_role_information GET /roles/roleId Get Role Information
ZoomUs::RolesApi role_member_delete DELETE /roles/roleId/members/memberId Unassign a Member's Role
ZoomUs::RolesApi role_members GET /roles/roleId/members List Members in a Role
ZoomUs::RolesApi roles GET /roles List Roles
ZoomUs::RolesApi update_role PATCH /roles/roleId Update Role Information
ZoomUs::RoomsApi add_a_room POST /rooms Add a Zoom Room
ZoomUs::RoomsApi change_zr_location PUT /rooms/roomId/location Change a Zoom Room's Location
ZoomUs::RoomsApi delete_a_zoom_room DELETE /rooms/roomId Delete a Zoom Room
ZoomUs::RoomsApi get_zr_profile GET /rooms/roomId Get Zoom Room Profile
ZoomUs::RoomsApi get_zr_settings GET /rooms/roomId/settings Get Zoom Room Settings
ZoomUs::RoomsApi list_zoom_rooms GET /rooms List Zoom Rooms
ZoomUs::RoomsApi list_zr_devices GET /rooms/roomId/devices List Zoom Room Devices
ZoomUs::RoomsApi update_room_profile PATCH /rooms/roomId Update a Zoom Room Profile
ZoomUs::RoomsApi update_zr_settings PATCH /rooms/roomId/settings Update Zoom Room Settings
ZoomUs::RoomsAccountApi get_zr_account_profile GET /rooms/account_profile Get Zoom Room Account Profile
ZoomUs::RoomsAccountApi get_zr_account_settings GET /rooms/account_settings Get Zoom Room Account Settings
ZoomUs::RoomsAccountApi update_zoom_room_acc_settings PATCH /rooms/account_settings Update Zoom Room Account Settings
ZoomUs::RoomsAccountApi update_zr_acc_profile PATCH /rooms/account_profile Update Zoom Room Account Profile
ZoomUs::RoomsLocationApi add_azr_location POST /rooms/locations Add a Location
ZoomUs::RoomsLocationApi change_parent_location PUT /rooms/locations/locationId/location Change the Assigned Parent Location
ZoomUs::RoomsLocationApi get_zr_location_profile GET /rooms/locations/locationId Get Zoom Room Location Profile
ZoomUs::RoomsLocationApi get_zr_location_settings GET /rooms/locations/locationId/settings Get Location Settings
ZoomUs::RoomsLocationApi get_zr_location_structure GET /rooms/locations/structure Get Zoom Room Location Structure
ZoomUs::RoomsLocationApi list_zr_locations GET /rooms/locations List Zoom Room Locations
ZoomUs::RoomsLocationApi update_zoom_rooms_location_structure PATCH /rooms/locations/structure Update Zoom Rooms Location Structure
ZoomUs::RoomsLocationApi update_zr_location_profile PATCH /rooms/locations/locationId Update Zoom Room Location Profile
ZoomUs::RoomsLocationApi update_zr_location_settings PATCH /rooms/locations/locationId/settings Update Location Settings
ZoomUs::SIPConnectedAudioApi assign_sip_config PATCH /accounts/accountId/sip_trunk/settings Assign SIP Trunk Configuration
ZoomUs::SIPConnectedAudioApi assign_sip_trunk_numbers POST /accounts/accountId/sip_trunk/numbers Assign Numbers
ZoomUs::SIPConnectedAudioApi delete_all_sip_numbers DELETE /accounts/accountId/sip_trunk/numbers Delete All Numbers
ZoomUs::SIPConnectedAudioApi list_sip_trunk_numbers GET /sip_trunk/numbers List SIP Trunk Numbers
ZoomUs::SIPPhone create_sip_phone POST /sip_phones Create SIP Phone
ZoomUs::SIPPhone delete_sip_phone DELETE /sip_phones/phoneId Delete SIP Phone
ZoomUs::SIPPhone list_sip_phones GET /sip_phones List SIP Phones
ZoomUs::SIPPhone update_sip_phone PATCH /sip_phones/phoneId Update SIP Phone
ZoomUs::TSPApi tsp GET /tsp Get Account's TSP Information
ZoomUs::TSPApi tsp_update PATCH /tsp Update account's TSP information
ZoomUs::TSPApi tsp_url_update PATCH /users/userId/tsp/settings Set Global Dial-in URL for a TSP User
ZoomUs::TSPApi user_ts_ps GET /users/userId/tsp List User's TSP accounts
ZoomUs::TSPApi user_tsp GET /users/userId/tsp/tspId Get a User's TSP Account
ZoomUs::TSPApi user_tsp_create POST /users/userId/tsp Add a User's TSP Account
ZoomUs::TSPApi user_tsp_delete DELETE /users/userId/tsp/tspId Delete a User's TSP Account
ZoomUs::TSPApi user_tsp_update PATCH /users/userId/tsp/tspId Update a TSP Account
ZoomUs::TrackingFieldApi trackingfield_create POST /tracking_fields Create a Tracking Field
ZoomUs::TrackingFieldApi trackingfield_delete DELETE /tracking_fields/fieldId Delete a Tracking Field
ZoomUs::TrackingFieldApi trackingfield_get GET /tracking_fields/fieldId Get a Tracking Field
ZoomUs::TrackingFieldApi trackingfield_list GET /tracking_fields List Tracking Fields
ZoomUs::TrackingFieldApi trackingfield_update PATCH /tracking_fields/fieldId Update a Tracking Field
ZoomUs::UsersApi switch_user_account PUT /accounts/accountId/users/userId/account Switch a User's Account
ZoomUs::UsersApi user GET /users/userId Get a User
ZoomUs::UsersApi user_assistant_create POST /users/userId/assistants Add Assistants
ZoomUs::UsersApi user_assistant_delete DELETE /users/userId/assistants/assistantId Delete a User Assistant
ZoomUs::UsersApi user_assistants GET /users/userId/assistants List User Assistants
ZoomUs::UsersApi user_assistants_delete DELETE /users/userId/assistants Delete User Assistants
ZoomUs::UsersApi user_create POST /users Create Users
ZoomUs::UsersApi user_delete DELETE /users/userId Delete User
ZoomUs::UsersApi user_email GET /users/email Check a User Email
ZoomUs::UsersApi user_email_update PUT /users/userId/email Update a User's Email
ZoomUs::UsersApi user_password PUT /users/userId/password Update a User's Password
ZoomUs::UsersApi user_permission GET /users/userId/permissions Get User Permissions
ZoomUs::UsersApi user_picture POST /users/userId/picture Upload a User's Profile Picture
ZoomUs::UsersApi user_scheduler_delete DELETE /users/userId/schedulers/schedulerId Delete a Scheduler
ZoomUs::UsersApi user_schedulers GET /users/userId/schedulers List User Schedulers
ZoomUs::UsersApi user_schedulers_delete DELETE /users/userId/schedulers Delete User Schedulers
ZoomUs::UsersApi user_settings GET /users/userId/settings Get User Settings
ZoomUs::UsersApi user_settings_update PATCH /users/userId/settings Update User Settings
ZoomUs::UsersApi user_sso_token_delete DELETE /users/userId/token Revoke a User's SSO Token
ZoomUs::UsersApi user_status PUT /users/userId/status Update User Status
ZoomUs::UsersApi user_token GET /users/userId/token Get a User Token
ZoomUs::UsersApi user_update PATCH /users/userId Update User
ZoomUs::UsersApi user_vanity_name GET /users/vanity_name Check a User's PM Room Name
ZoomUs::UsersApi user_zpk GET /users/zpk Verify a User's zpk (Deprecated)
ZoomUs::UsersApi users GET /users List Users
ZoomUs::WebinarsApi get_tracking_sources GET /webinars/webinarId/tracking_sources Get Webinar Tracking Sources
ZoomUs::WebinarsApi list_past_webinar_files GET /past_webinars/webinarId/files List Past Webinar Files
ZoomUs::WebinarsApi list_past_webinar_poll_results GET /past_webinars/webinarId/polls List Past Webinar Poll Results
ZoomUs::WebinarsApi list_past_webinar_qa GET /past_webinars/webinarId/qa List Q&A of Past Webinar
ZoomUs::WebinarsApi past_webinars GET /past_webinars/webinarId/instances List Past Webinar Instances
ZoomUs::WebinarsApi webinar GET /webinars/webinarId Get a Webinar
ZoomUs::WebinarsApi webinar_absentees GET /past_webinars/WebinarUUID/absentees Get Webinar Absentees
ZoomUs::WebinarsApi webinar_create POST /users/userId/webinars Create a Webinar
ZoomUs::WebinarsApi webinar_delete DELETE /webinars/webinarId Delete a Webinar
ZoomUs::WebinarsApi webinar_panelist_create POST /webinars/webinarId/panelists Add Panelists
ZoomUs::WebinarsApi webinar_panelist_delete DELETE /webinars/webinarId/panelists/panelistId Remove a Panelist
ZoomUs::WebinarsApi webinar_panelists GET /webinars/webinarId/panelists List Panelists
ZoomUs::WebinarsApi webinar_panelists_delete DELETE /webinars/webinarId/panelists Remove Panelists
ZoomUs::WebinarsApi webinar_poll_create POST /webinars/webinarId/polls Create a Webinar's Poll
ZoomUs::WebinarsApi webinar_poll_delete DELETE /webinars/webinarId/polls/pollId Delete a Webinar Poll
ZoomUs::WebinarsApi webinar_poll_get GET /webinars/webinarId/polls/pollId Get a Webinar Poll
ZoomUs::WebinarsApi webinar_poll_update PUT /webinars/webinarId/polls/pollId Update a Webinar Poll
ZoomUs::WebinarsApi webinar_polls GET /webinars/webinarId/polls List a Webinar's Polls
ZoomUs::WebinarsApi webinar_registrant_create POST /webinars/webinarId/registrants Add a Webinar Registrant
ZoomUs::WebinarsApi webinar_registrant_get GET /webinars/webinarId/registrants/registrantId Get a Webinar Registrant
ZoomUs::WebinarsApi webinar_registrant_question_update PATCH /webinars/webinarId/registrants/questions Update Registration Questions
ZoomUs::WebinarsApi webinar_registrant_status PUT /webinars/webinarId/registrants/status Update Webinar Registrant Status
ZoomUs::WebinarsApi webinar_registrants GET /webinars/webinarId/registrants List Webinar Registrants
ZoomUs::WebinarsApi webinar_registrants_questions_get GET /webinars/webinarId/registrants/questions List Registration Questions
ZoomUs::WebinarsApi webinar_status PUT /webinars/webinarId/status Update Webinar Status
ZoomUs::WebinarsApi webinar_update PATCH /webinars/webinarId Update a Webinar
ZoomUs::WebinarsApi webinars GET /users/userId/webinars List Webinars

Documentation for Models

Documentation for Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Client Credentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

OAuth