wxc_sdk

A simple SDK to work with Webex APIs, special focus on Webex Calling specific API endpoints.

This is how easy it is to use the SDK. The example code list all calling enabled users within the org.

#!/usr/bin/env python
"""
Example script
Get all calling users within the org
"""

from dotenv import load_dotenv

from wxc_sdk import WebexSimpleApi

load_dotenv()

api = WebexSimpleApi()

# using wxc_sdk.people.PeopleApi.list to iterate over persons
# Parameter calling_data needs to be set to true to gat calling specific information
# calling users have the attribute location_id set
calling_users = [user for user in api.people.list(calling_data=True)
                 if user.location_id]
print(f'{len(calling_users)} users:')
print('\n'.join(user.display_name for user in calling_users))

Installation

Installing and upgrading wxc_sdk is easy:

Install via PIP

$ pip install wxc-sdk

Upgrade to the latest version

$ pip install wxc-sdk --upgrade

Documentation

Documentation is available at: http://wxc_sdk.readthedocs.io

Examples

Sample scripts are available in the examples folder.

Also the test cases in the tests folder can serve as examples of how to use the SDK.

Datatypes

Datatypes are defined in the respective subpackages and submodules and have to be imported from there explicitly:

from wxc_sdk.people import Person
from wxc_sdk.person_settings.barge import BargeSettings

To allow to abstract from the subpackage and submodule structure any datatype can also be imported from wxc_sdk.all_types directly:

from wxc_sdk.all_types import Person, BargeSettings

All wxc_sdk data types can also be imported at once:

from wxc_sdk.all_types import *

Async version of the SDK (experimental)

With wxc_sdk.as_api.AsWebexSimpleApi the SDK offers an async variant based on asyncio/aiohttp. This variant is automatically generated based off the source of the synchronous API and offers async variants of the endpoints using the same datastructures as the synchronous API.

Here is an example of how to use the async SDK:

#!/usr/bin/env python
"""
Example script
Get all calling users within the org using the (experimental) async API
"""
import asyncio
import time

from dotenv import load_dotenv

from wxc_sdk.as_api import AsWebexSimpleApi

load_dotenv()


async def get_calling_users():
    """
    Get details of all calling enabled users by:
    1) getting all calling users
    2) collecting all users that have a calling license
    3) getting details for all users
    """
    async with AsWebexSimpleApi(concurrent_requests=40) as api:
        print('Collecting calling licenses')
        calling_license_ids = set(lic.license_id for lic in await api.licenses.list()
                                  if lic.webex_calling)

        # get users with a calling license
        calling_users = [user async for user in api.people.list_gen()
                         if any(lic_id in calling_license_ids for lic_id in user.licenses)]
        print(f'{len(calling_users)} users:')
        print('\n'.join(user.display_name for user in calling_users))

        # get details for all users
        start = time.perf_counter()
        details = await asyncio.gather(*[api.people.details(person_id=user.person_id, calling_data=True)
                                         for user in calling_users])
        expired = time.perf_counter() - start
        print(f'Got details for {len(details)} users in {expired * 1000:.3f} ms')


if __name__ == '__main__':
    asyncio.run(get_calling_users())