Skip to main content

Zoom API client for Python using server to server tokens

Project description

Zoom Python client

Python tests pre-commit CodeQL codecov

Zoom API Python client with support for Server to Server Oauth tokens

Install

This package is available on Pypi

pip install zoom-python-client

Requirements

  • Python >= 3.9

Usage

Defining your env variables

Define the following variables in your env or your .env file:

  • ZOOM_ACCOUNT_ID
  • ZOOM_CLIENT_ID
  • ZOOM_CLIENT_SECRET

Initialize the ZoomApiClient from environment variables

from zoom_python_client.zoom_api_client import ZoomApiClient

zoom_client = ZoomApiClient.init_from_env()

Initialize the ZoomApiClient from .env

from zoom_python_client.zoom_api_client import ZoomApiClient

zoom_client = ZoomApiClient.init_from_dotenv()

Initialize the ZoomApiClient manually

from zoom_python_client.zoom_api_client import ZoomApiClient

zoom_client = ZoomApiClient(
        account_id="<YOUR ACCOUNT ID>",
        client_id="<YOUR CLIENT ID>",
        client_secret="<YOUR CLIENT SECRET>")

Use the file system to store the access token instead of environment

There are some cases where you might want to store the access token in the file system in order to share its value with other elements of the application (Ex. different pods on a Kubernetes/Openshift application).

You can define the path where the token will be stored, passing the use_path variable to the constructor:

from zoom_python_client.zoom_api_client import ZoomApiClient

zoom_client = ZoomApiClient(
        account_id="<YOUR ACCOUNT ID>",
        client_id="<YOUR CLIENT ID>",
        client_secret="<YOUR CLIENT SECRET>",
        use_path="/path/to/token/folder")

How to make API calls

MEETING_ID = "12345"
USER_ID = "abcdfgh"

result = zoom_client.users.get_user(USER_ID)
print(result)

result = zoom_client.meetings.get_meeting(MEETING_ID)
print(result)

Optional: How to configure the logging

from zoom_python_client.utils.logger import setup_logs

setup_logs(log_level=logging.DEBUG)

Available endpoints

users:

  1. get user details
  2. get user meetings

meetings:

  1. get meeting details
  2. get meeting token

meeting live streams:

  1. get meeting live stream
  2. update live stream
  3. update livestream status

webinars:

  1. get webinar details

webinar live streams:

  1. get webinar live stream
  2. update webinar live stream
  3. update webinar livestream status - Following Zoom documentation.

zoom rooms:

  1. get all zoom rooms
  2. get zoom room details
  3. get zoom room sensor data

calendars:

  1. get calendar services list
  2. get calendar resources list
  3. get calendar resources by service id list
  4. get calendar resource details by id

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zoom_python_client-0.2.3.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zoom_python_client-0.2.3-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file zoom_python_client-0.2.3.tar.gz.

File metadata

  • Download URL: zoom_python_client-0.2.3.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.13.1 Linux/6.14.0-1017-azure

File hashes

Hashes for zoom_python_client-0.2.3.tar.gz
Algorithm Hash digest
SHA256 9772221a451f53bd656fcb50266ebe637c04dcfd07fed236738e04aae2568879
MD5 6ba286ab64e014301e13fa9481094010
BLAKE2b-256 0f8010314ad5968e6747ae091cb9052967c494ea05b7dca5332ca036b9153aef

See more details on using hashes here.

File details

Details for the file zoom_python_client-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: zoom_python_client-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.13.1 Linux/6.14.0-1017-azure

File hashes

Hashes for zoom_python_client-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6b464e2fa7740c667bb780fa14d02a171a9c808679b48dd46c79a9b3986012a5
MD5 35027d7576d2a369e5dc7e75c412aa41
BLAKE2b-256 665920d9145a4d60e3bc27b0393769111b37936a89403d0cac37bb7e7cca7305

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page