Skip to main content

A Python 3 Library for Webex Calling Administrators

Project description

wxcadm

Python Library for Webex Calling Administration

Purpose

wxcadm is a Python 3 library to simplify the API calls to Webex in order to manage and report on users of Webex Calling. Although the primary focus is Webex Calling, many of the other Webex admin functions are included. This library is not meant to be an interface to the Meetings and Messaging capabilities of Webex....there are plenty of other modules that provide that.

Installation

wxcadm is available as a PIP Package

$ python -m pip install wxcadm

Quickstart

By creating a Webex instance with a valid API Access Token, the module will pull the Webex Organization information as well as all the People within the Organization. The Org instance will contain all People, whether they have the Webex Calling service or not. An Org method get_webex_people() makes it easy to get only the People that have Webex Calling.

You can obtain a 12-hour access token by logging into https://developer.webex.com and visiting the Getting Started page.

Once you have the access token, the following will initialize the API connection and pull data

import wxcadm

access_token = "Your API Access Token"
webex = wxcadm.Webex(access_token)

Since most administrators only have access to a single Webex Organization, you can access that Organization with the org attribute. If the administrator has access to more than one Organization, they can be accessed using the orgs attribute, which is a list of the organizations that can be managed. See the "Regarding Multiple Organizations" section below for further information.

You can see all the attributes with

vars(webex.org)

Note that, by default, all the People are pulled when the Org is initialized. For large organizations, this may take a while, but then all the People are stored as Person objects.

To iterate over the list of people, simply loop through the people attribute of the Org. For example:

for person in webex.org.people:
    # Print all of the attributes of the Person
    print(vars(person))
    # Or access the attributes directly
    email = person.email

Documentation

wxcadm documentation is housed at Read The Docs.

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

wxcadm-4.3.0.tar.gz (134.5 kB view details)

Uploaded Source

Built Distribution

wxcadm-4.3.0-py3-none-any.whl (151.0 kB view details)

Uploaded Python 3

File details

Details for the file wxcadm-4.3.0.tar.gz.

File metadata

  • Download URL: wxcadm-4.3.0.tar.gz
  • Upload date:
  • Size: 134.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for wxcadm-4.3.0.tar.gz
Algorithm Hash digest
SHA256 0a1bb36484b4b0e10eeba99c187c2e027786f01746f751dafbd7507529b9af17
MD5 0eb864f2f0690ca0e7bc2744652ea743
BLAKE2b-256 68b8e50b07f3d91aaf7dc87a5039872027737f772c90121ba48b7ec3b9e136fb

See more details on using hashes here.

File details

Details for the file wxcadm-4.3.0-py3-none-any.whl.

File metadata

  • Download URL: wxcadm-4.3.0-py3-none-any.whl
  • Upload date:
  • Size: 151.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for wxcadm-4.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58d3080bb779a3632106fb13907f27c8e4a8d67ba591cf73b110a5680ee33195
MD5 eb4bc3c32a5ccfc32470dc0dba44027e
BLAKE2b-256 5a5973aea184d9be6aa037fe684c00ea7a416c62799e1e6358339503f2441f58

See more details on using hashes here.

Supported by

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