Lab 11 - Webex CC APIs

Last modified: Mon, 19 Jun 2023

Topic	Lab Type	Difficulty Level	Estimated length
Introduction to the New Webex CC APIs	Practical Lab	MID	25 min
Reporting APIs	Practical Lab	MID	25 min
Call Recording APIs	Practical Lab	EASY	15 min
Configuration APIs	Practical Lab	MID	20 min
Search API	Practical Lab	MID	25 min
Agent Desktop APIs	Practical Lab	MID	25 min

Introduction

Important: Changes to the API Lab.

The New Webex Contact Center APIs are now available on developer.webex-cx.com and use OAuth2 as opposed to One-time API Keys.
The Legacy APIs (v1) are still available and are documented in the later section of this lab.
The lab assumes that you will use the All New Webex Contact Center APIs which are documented below.
For a quick start and overview, refer to the Overview / Quick start section.

All New Webex Contact Center APIs (New Version)

Introduction to the New Webex CC APIs

This is the introduction video. It explains what API we have, what application and authorization mechanisms exist and how to get started.

1. Walkthrough of Auth Flow

To develop applications with the new APIs, you must build an integration with Webex.
See Contact Center Dev Portal Docs for all the details.

Here is a summary:

API Access- create an Integration

The New Webex Contact Center APIs are accessed by using Webex OAuth2
Watch this video to create an integration and run APIs on postman.
Steps to create an integration and use on postman
OAuth2 by design, requires a client ID, clinet secret, callback URL(Redirect URL)
Use the Client ID, Client Secret, Redirect URI (callback URL) to obtain access_token for your Org. Use the Access token to hit the API inside of the Authorization header.

Authorization: Bearer yourAccessToken

Use the refresh_token before it expires to renew your access_token - and get a new set of Access and Refresh Tokens.

By Default, the access_token is valid for 12 hours and the refresh token is valid for 60 days, however using another call for the refresh token will give you a new set of tokens. Maintaining this access is important for perpetual access. One can write a simple scheduler that performs this background refresh activity.

OAuth2 Mechanism - Implications

With the OAuth2 support- Will require a “One Time Onboarding” User interface to obtain access to an org
“Login with Webex” > Button to access an org
You will register an App with us and use it for N orgs
Have each Org administrator login into your App at least once to obtain the tokens
This is a “Required Onboarding “ Process
Once you obtain an Org’s access_token and refresh_token, you can access their data

OAuth2 Access Token Flow

Your App redirects to authorize with Webex (GET)

GET https://webexapis.com/v1/authorize?client_id=______&response_type=code&redirect_uri=_https://your-app/auth___&scope=cjp:config_read&state=set_state_here

Admin user COMPLETES login.Redirect back to your App (GET)

GET https://your-app/auth?code=___unique_code_sent

Your App usess this code - API Endpoint - and then sends a POST request back to Webex
Request Access Token AND/OR Refresh Tokens (POST)

POST https://webexapis.com/v1/access_token` application/x-www-form-urlencoded

{"access_token":"ZDI3MGEyYzQtNmFlNS00NDNhLWFlNzAtZGVjNjE0MGU1OGZmZWNmZDEwN2ItYTU3",
"expires_in":1209600,
"refresh_token":"MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTEyMzQ1Njc4",
"refresh_token_expires_in":7776000 }

Expiry in seconds and required x-www-form-urlencoded values include

grant_type = authorisation_code OR refresh_token

client_id

client_secret

code

redirect_uri

2. Initial Setup of Sample App

Login with the POD admin account to https://developer.webex-cx.com/.
Go to > Documentation > API Reference.
Follow the instructions in the video to request access to your sample app.
The sample app is available here :https://github.com/CiscoDevNet/webex-contact-center-api-samples/tree/main/app-auth-sample
Follow the instructions in the video to clone the repository and run the app.

Reporting APIs

In this video we will go through the developer portal and execute your first API calls through Postman.

Login with the POD admin account to https://developer.webex-cx.com/.
Go to > Documentation > API Reference.

1. Executing “Get Tasks” API

Go to the Tasks section.
Click on GET Tasks > Try Out
Fetch all the tasks using the “From Date/time” in Epoch milliseconds.
To get the Epoch time use epochconverter
Enter the Org ID and channel type > Press Run

The same request can be drafted on Postman using your personal Bearer Token.

Example of a GET Task: https://api.wxcc-us1.cisco.com/v1/tasks

Create a new collection in Postman
Under that add a request
Enter the request URL copied from the developer portal. Make changes to the from and to times and the org ID to refelect your tenant.
Under Headers enter the Key: Authorization and Value _: _Bearer ‘Your Bearer token copied from the developer portal’
Under Parameters enter the values you wil be passing as shown in the video
Click on Send