Getting Started

Hey there! Thanks for checking out Cisco Webex for Developers. If you've used Cisco Webex Meetings or Cisco Webex Teams (formerly Cisco Spark) you know how easy it is to meet and collaborate with your team members and customers.

The Webex for Developers program opens up the power behind the Webex platform to anyone seeking to extend the Webex experience.

Webex Meetings is a powerful conferencing solution that lets you connect with anyone, anywhere, in real time. By combining video, audio and content sharing, Webex Meetings creates an effective conferencing environment, leading to more productive meetings and increased productivity. Developer information for Webex Meetings will soon be available on this site. In the meantime, to get started with developing for Webex Meetings, please see the Getting Started guides over on Cisco DevNet. Keep reading for information about Webex Teams.

Webex Teams makes staying in sync with your teammates and customers easy. If you're new to Webex Teams, go create an account and come back when you're finished.

Conversations in Webex Teams take place in virtual meeting rooms. Some rooms live for a few hours while others become permanent fixtures of your team's workflow with titles like Daily Standup or Build Status. Webex Teams allows conversations to flow seamlessly between messages, video calls, and real-time whiteboarding sessions. No other solution brings together so many facets of collaboration into a single unified platform.

What's possible with the Webex Teams APIs?

The Webex Team APIs give your applications direct access to the Cisco Webex platform, giving you the ability to:

But enough talk! Since you're logged in we can just show you. Click on the Run button bellow to see the APIs in action:

m
You're not logged in. to run the demo.

curl https://api.ciscospark.com/v1/messages -X POST -H "Authorization:Bearer {{ACCESS_TOKEN}}" --data "toPersonId={{DEVSUPPORT_ID}}" --data "text=Hi%20Sparky"

Now go to the Webex Teams app and see what happened! j

Using the Messages API we were able to send a message to Sparky as you. Sparky is a simple bot that replies to any message with a quote of the day.

Authentication

You'll notice that an Authorization header was sent along with the request above. This is how the Webex Teams APIs validate access and identify the requesting user. In the example above, we used your personal access (or portal) token:

Please to get your auth token.

This access token allows you to perform actions in Webex Teams as yourself. For example, inviting someone into a room with the Memberships API appears just as if you had invited them via one of the Webex Teams clients.

Your personal access token will be valid for a limited amount of time and is the most effective way to learn and explore the Webex Teams APIs. If you log out of your Webex Teams account on this site, the token will immediately expire and you'll be issued a new token when you log in again.

Your personal access token is great for testing the API with your account but it should never be used in applications.

Interacting with Webex Teams as yourself is great but there are many cases when you'll want to perform actions on behalf of someone else. To do this, you will need a separate access token that you obtain through an OAuth authorization grant flow. Fortunately, we've baked OAuth support directly into the platform. With a few easy steps you can have a Webex Teams user grant permission to your app and perform actions on their behalf. For more information see the Apps & Authentication Guide.

Methods & Content Types

The Webex Teams APIs are RESTful. In REST, each resource is represented by a base URL like /messages and the HTTP methods GET, POST, PUT and DELETE are used to request data and perform actions on those resources.

For methods that accept request parameters the platform accepts either application/json or application/x-www-form-urlencoded content types and currently only supports returning data in application/json format.

Next Steps

We've tried to make it as simple as possible to explore and learn the Webex Teams APIs. If you're the type of person that learns by doing then jump straight into the Quick Reference to get a listing of the available API endpoints. Once you find an endpoint that looks interesting go to that section and make sure to enable Test Mode using the toggle on the top righthand corner. In Test Mode you can make APIs requests directly from the docs and see the HTTP response from the Webex Teams Platform.

If you prefer tutorials and guided lessons definitely check out Samples and Tutorials for some hands on Learning Labs powered by Cisco DevNet.

Once you've learned the APIs and are ready to build a real app you may be interested in using an SDK to eliminate some boilerplate. If your favorite language is not listed don't worry, SDKs in new languages will be added regularly.

Getting Help

If you ever get stuck, the Webex Developer Support team has you covered, standing by 24/7 to help you build amazing collaboration apps. Check out Support for more info.