anchorWhat's possible with the Webex APIs?

The Webex APIs provide your applications with direct access to the Cisco Webex Platform, giving you the ability to:

• Create a Webex space and invite people
• Search for people in your company
• Post messages in a Webex space
• Get Webex space history or be notified in real-time when new messages are posted by others
• Execute a command on a Webex RoomOS device
• and much more!

anchorAccounts and Authentication

To use the Webex REST API you'll need a Webex account backed by Cisco Webex Common Identity (CI). If you already have a Webex account, you're all set. If you're using Webex Meetings, your site will need to be on Common Identity.

If you don't already have a Webex account, go ahead and sign up! You'll need an account to use the APIs and SDKs.

When making requests to the Webex REST API, an Authentication HTTP header is used to identify the requesting user. This header must include an access token. This access token may be a personal access token, a Bot token, or an OAuth token from an Integration or Guest Issuer application.

anchorPersonal Access Tokens

A personal access token is a short-lived access token you can use to make Webex API calls on your own behalf. Any actions taken through the API will be done as you. Personal access tokens expire 12 hours after you sign in to the Developer Portal and should not be used in production environments. A production app should instead create an integration to obtain an access token from an authenticating user using OAuth.

To get your personal access token:

1. Make sure you're signed in to the Developer Portal.

2. Click the copy icon below.

   Your Personal Access Token

   Log in required for access token.

   Bearer

   This limited-duration personal access token is hidden for your security.

3. Click OK in the dialog to copy the token to your clipboard.

   

anchorMethods & Content Types

The Webex 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.

anchorNext Steps

We've tried to make it as simple as possible to explore and learn the Webex APIs. Browse through the list of API endpoints under the Reference section in the menu on the left. Once you find an endpoint that looks interesting, go to that endpoint and give it a try! You can perform a request and see the results right in your browser.

If you prefer tutorials and structured lessons definitely check out the Learning Labs by Cisco DevNet.

Once you've learned the APIs and are ready to build an app you may be interested in using an SDK to eliminate some boilerplate. Check our list of SDKs over in the menu on the left side of this page. If your favorite language isn't listed don't worry, SDKs in new languages will be added regularly.

anchorSupport Policy

Please visit the Webex API and SDK Support Policy page for details on our support and end of life policy for APIs and SDKs.

anchorGetting Help

If you ever get stuck, the Webex Developer Support team has you covered, standing by 24/7 to help.