Skip to content

rootalley/py-zoom-api

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
docs
docs
 
 
swagger_client
swagger_client
 
 
test
test
 
 
README.md
README.md
 
 
git_push.sh
git_push.sh
 
 
requirements.txt
requirements.txt
 
 
setup.py
setup.py
 
 
test-requirements.txt
test-requirements.txt
 
 
tox.ini
tox.ini
 
 

Repository files navigation

swagger-client

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 Python package is automatically generated by the Swagger Codegen project:

  • API version: 2.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://developer.zoom.us/

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_id = 'account_id_example' # str | The account ID.

try:
    # Get a Sub Account
    api_response = api_instance.account(account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->account: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
body = swagger_client.Body20() # Body20 | Account.

try:
    # Create a Sub Account
    api_response = api_instance.account_create(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->account_create: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_id = 'account_id_example' # str | The account ID.

try:
    # Disassociate a Sub Account
    api_instance.account_disassociate(account_id)
except ApiException as e:
    print("Exception when calling AccountsApi->account_disassociate: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_id = 'account_id_example' # str | Unique Identifier of the account. To retrieve locked settings of the Master account or a regular account, provide \"me\" as the value of this field. <br> To retrieve locked settings of a Sub Account, provide the Account ID of the Sub Account in this field.

try:
    # Get Managed Domains
    api_response = api_instance.account_managed_domain(account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->account_managed_domain: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
body = swagger_client.Body22() # Body22 | 
account_id = 'account_id_example' # str | The account ID.

try:
    # Update Options
    api_instance.account_options_update(body, account_id)
except ApiException as e:
    print("Exception when calling AccountsApi->account_options_update: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_id = 'account_id_example' # str | The account ID.
option = 'option_example' # str | `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.<br>`recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account. (optional)

try:
    # Get Settings
    api_response = api_instance.account_settings(account_id, option=option)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->account_settings: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
body = NULL # object | 
account_id = 'account_id_example' # str | The account ID.
option = 'option_example' # str |  (optional)

try:
    # Update Settings
    api_instance.account_settings_update(body, account_id, option=option)
except ApiException as e:
    print("Exception when calling AccountsApi->account_settings_update: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_id = 'account_id_example' # str | The account ID.

try:
    # Get Trusted Domains
    api_response = api_instance.account_trusted_domain(account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->account_trusted_domain: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
page_size = 30 # int | The number of records returned within a single API call. (optional) (default to 30)
page_number = 1 # int | The current page number of returned records. (optional) (default to 1)

try:
    # List Sub Accounts
    api_response = api_instance.accounts(page_size=page_size, page_number=page_number)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->accounts: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_id = 'account_id_example' # str | Unique Identifier of the account. To retrieve locked settings of the Master account or a regular account, provide \"me\" as the value of this field. <br> To retrieve locked settings of a Sub Account, provide the Account ID of the Sub Account in this field.

try:
    # Get Locked Settings
    api_response = api_instance.get_account_lock_settings(account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->get_account_lock_settings: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_id = 'account_id_example' # str | Unique Identifier of the account. To retrieve locked settings of the Master account or a regular account, provide \"me\" as the value of this field. <br> To retrieve locked settings of a Sub Account, provide the Account ID of the Sub Account in this field.
body = swagger_client.Body131() # Body131 |  (optional)

try:
    # Update Locked Settings
    api_response = api_instance.update_account_lock_settings(account_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->update_account_lock_settings: %s\n" % e)

# Configure OAuth2 access token for authorization: OAuth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_id = 'account_id_example' # str | Account Id of the account.
body = swagger_client.Body135() # Body135 |  (optional)

try:
    # Update the Account Owner
    api_response = api_instance.update_account_owner(account_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->update_account_owner: %s\n" % e)

Documentation for API Endpoints

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

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

OAuth

Author

developersupport@zoom.us

About

Python Client for the Zoom API

Resources

Readme
Activity

Stars

2 stars

Watchers

1 watching

Forks

3 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages