Webex Teams SDK

1.7 · deprecated · verified Wed Apr 15

The `webexteamssdk` is a community-developed Python SDK for interacting with the Webex Teams (now Webex App) APIs. While it achieved its last official release at v1.7, the project has been superseded by `webexpythonsdk` since October 2022, which is now the actively maintained version. Users are strongly encouraged to migrate to `webexpythonsdk` for new projects and ongoing development.

Warnings

breaking `webexteamssdk` is officially deprecated. The maintainers have replaced it with `webexpythonsdk` (available via `pip install webexpythonsdk`). While functionally similar, `webexpythonsdk` requires Python 3.10+ and uses a different package name.
Fix: Migrate your project to `webexpythonsdk`. Update your `requirements.txt` and import statements (e.g., `from webexpythonsdk import WebexTeamsAPI`). Review `webexpythonsdk` documentation for any minor API changes.
gotcha The original GitHub repository `CiscoDevNet/webexteamssdk` is no longer actively maintained. All new development and bug fixes are happening in the `WebexCommunity/WebexPythonSDK` repository, which corresponds to the `webexpythonsdk` package.
Fix: For support, issues, or contributions, refer to the `webexpythonsdk` project's GitHub repository. Do not open issues on the `CiscoDevNet/webexteamssdk` repo.
gotcha API access requires an access token. The SDK primarily expects it via the `WEBEX_TEAMS_ACCESS_TOKEN` environment variable. Misconfiguration often leads to `401 Unauthorized` errors.
Fix: Ensure `WEBEX_TEAMS_ACCESS_TOKEN` is correctly set in your environment with a valid token from developer.webex.com/my-apps. If providing explicitly, pass `access_token='YOUR_TOKEN'` to `WebexTeamsAPI()`.
gotcha Webex APIs are rate-limited. While `webexteamssdk` has some retry mechanisms, intensive use might hit limits. Malformed `Retry-After` headers from the API could historically cause crashes (fixed in `webexpythonsdk` v2.0.5).
Fix: Implement robust error handling for `ApiError` exceptions. Consider adding delays between consecutive API calls, or migrate to `webexpythonsdk` which has improved rate limit handling.

Install

pip install webexteamssdk Install `webexteamssdk`

Imports

WebexTeamsAPI
wrong:
```
from webexpythonsdk import WebexTeamsAPI
```
correct:
```
from webexteamssdk import WebexTeamsAPI
```
`webexpythonsdk` is the successor library, but this entry is for `webexteamssdk`.

Quickstart

Demonstrates initializing the API with an access token (expected via environment variable) and fetching information about the authenticated user and their rooms.

import os
from webexteamssdk import WebexTeamsAPI

# Initialize the API connection
# By default, the SDK looks for a WEBEX_TEAMS_ACCESS_TOKEN environment variable.
# Ensure your Webex access token is set in your environment.
access_token = os.environ.get('WEBEX_TEAMS_ACCESS_TOKEN', '')

if not access_token:
    print("Error: WEBEX_TEAMS_ACCESS_TOKEN environment variable not set.")
    print("Please get a token from developer.webex.com/my-apps and set it.")
else:
    try:
        api = WebexTeamsAPI(access_token=access_token)

        # Get details about the authenticated user
        me = api.people.me()
        print(f"Authenticated as: {me.displayName} (ID: {me.id})")

        # List up to 5 rooms (spaces)
        print("\nMy Spaces (max 5):")
        for room in api.rooms.list(max=5):
            print(f"- {room.title} (ID: {room.id})")

    except Exception as e:
        print(f"An error occurred: {e}")
        if "401 Unauthorized" in str(e) or "access token" in str(e):
            print("Please verify your WEBEX_TEAMS_ACCESS_TOKEN is valid and not expired.")

view raw JSON →