Repository files navigation

Work with the Webex APIs in native Python!

Welcome to the newwebexpythonsdk library! The latest release removes support for Python v2 andis compatible with Python v3.10+. The new Webex Python SDK replaces the previouswebexteamssdk;and with the exception of the Python version support and the name change, the two libraries arefunctionally equivalent. The new library is the recommended choice for new projects, andwebexteamssdk users are encouraged tomigrate towebexpythonsdk.

webexpythonsdk is acommunity developed Python library for working with the Webex APIs. Ourgoal is to make working with Webex in Python anative andnatural experience!

fromwebexpythonsdkimportWebexAPIapi=WebexAPI()# Find all rooms that have 'webexpythonsdk Demo' in their titleall_rooms=api.rooms.list()demo_rooms= [roomforroominall_roomsif'webexpythonsdk Demo'inroom.title]# Delete all of the demo roomsforroomindemo_rooms:api.rooms.delete(room.id)# Create a new demo roomdemo_room=api.rooms.create('webexpythonsdk Demo')# Add people to the new demo roomemail_addresses= ["test01@cmlccie.com","test02@cmlccie.com"]foremailinemail_addresses:api.memberships.create(demo_room.id,personEmail=email)# Post a message to the new room, and upload a fileapi.messages.create(demo_room.id,text="Welcome to the room!",files=["https://www.webex.com/content/dam/wbx/us/images/navigation/CiscoWebex-Logo_white.png"])

That's more than 6 Webex API calls in less than 23 lines of code (with comments and whitespace),and likely more than that, since webexpythonsdk handlespagination for you automatically!

webexpythonsdk makes your life better...Learn how!

webexpythonsdk does all of this for you:

• Transparently sources your Webex access token from your local environment
• Provides and uses default arguments and settings everywhere possible, so you don't have to thinkabout things like API endpoint URLs, HTTP headers and JSON formats
• Represents all Webex API interactions using native Python tools
  • Authentication and Connection to the Webex Cloud ==>WebexAPI "connection object"
  • API Calls ==> Hierarchically organized methods underneath theWebexAPI 'Connection Object'
  • Returned Data Objects ==> Native Python objects
• Automatic and transparent pagination!
• Automatic rate-limit handling!(wait|retry)
• Multipart encoding and uploading of local files
• Auto-completion in your favorite IDE, descriptive exceptions, and so much more...

Installing and upgrading webexpythonsdk is easy:

Install via PIP

$ pip install webexpythonsdk

Upgrade to the latest version

$ pip install webexpythonsdk --upgrade

Excellent documentation is now available at:https://webexcommunity.github.io/WebexPythonSDK

Check out theQuickstart to dive in and begin using webexpythonsdk.

Are you looking for some sample scripts? Check out theexamples folder!

Have a good example script you would like to share? Please feel free tocontribute!

Please see thereleases page for release notes on the incremental functionality and bug fixesincorporated into the published releases.

webexpythonsdk is acommunity developed andcommunity-supported project. If you experience anyissues using this package, please report them using theissues page.

Please join theWebex Python SDK - Python Community Contributors Webex space to ask questions,join the discussion, and share your projects and creations.

webexpythonsdk is a community development project. Feedback, thoughts, ideas, and codecontributions are welcome! Please see theContributing guide for more information.

The Webex Python SDK (webexpythonsdk) library started as Cisco Spark API (ciscosparkapi) whichbecame Webex Teams SDK and then Webex Python SDK (webexpythonsdk). We updated the library's name inalignment with Cisco's re-brand of Cisco Spark to Webex and then again to align the name with thebroader set of Webex APIs accessible via the SDK (meetings, recordings, etc.). The previousversions of the library are deprecated and no longer supported; however, their open-source codebaseis still available in therelease/v0/ciscosparkapi andrelease/v1/webexteamssdk branches inthis repository.

• webexpythonsdk (current) is compatible with Python v3.10+ and is the recommended library fornew projects.
• webexteamssdk (deprecated) is compatible with Python v2 and v3 (<= v3.10) and is stillavailable for existing projects. Users are encouraged to migrate towebexpythonsdk.
• ciscosparkapi (deprecated) is compatible with Python v2 and v3 (<= v3.6) and should no longerbe used.

Copyright (c) 2016-2024 Cisco and/or its affiliates.