Introducing the Webex Contact Center APIs and Developer PortalApril 25, 2023
The Webex Contact Center suite is a “pure-cloud” solution that solves Contact Center business problems and helps run efficient customer experience centers to maximize customer satisfaction and transform “Contact centers” into “Experience centers”.
The Contact Center application suite enables omnichannel inbound interaction routing, (Voice, Chat, Email, Social, SMS, and more) and helps business connect their customers to agents by passing customer context with a data-driven routing model – bringing in customer interactions on an Agent Desktop application where users can manage these interactions effectively. The Webex Contact Center APIs surface the power of the platform by providing all the interfaces used by in-house applications and makes them available publicly to developers on the Developer Portal.
The platform now has a powerful set of APIs that serve all these use cases and can be grouped into the following groups. We will trace the entire life cycle of a Contact Center interaction and understand how these maps to the APIs available on the Developer Portal.
Webex Contact Center API Authentication works on the OAuth2 specification outlined in API Authentication and requires the application to secure a temporary Access Token to access the APIs.
This token is secure and expires after a certain duration. To learn more about Authentication, see the Authentication Sample.
Can an application secure permanent access to the APIs without user intervention?
Learn about token management and the Refresh Token flow for apps that do not require user logins. The Token Management Sample shows you how to get an access token that refreshes in the background to maintain API access with Webex Contact Center.
Provision a Contact Center using Configuration APIs
The admin settings are now available in the Contact Center Admin Portal but those controls will be migrated to Webex Control Hub shortly.
Before you begin using the APIs it is important to understand the flow of a contact through the system. First, a contact hits an Entry Point which is mapped to a Flow orchestration script that chooses the contact handling, along with the Queue that is chosen to pick an Agent from a given Team of Agents. These APIs are configured for users with an “admin” scope.
The configuration APIs available today - Create, Read, Update, and Delete (CRUD) endpoints via REST APIs, make this end-to-end configuration possible via touchless automation.
Some key admin controls include:
- Entry Points (https://developer.webex-cx.com/documentation/entry-point)
- Queues (https://developer.webex-cx.com/documentation/queues)
- Teams (https://developer.webex-cx.com/documentation/team)
- Users (https://developer.webex-cx.com/documentation/users)
- User Profiles (https://developer.webex-cx.com/documentation/user-profiles)
- Agent Profiles (https://developer.webex-cx.com/documentation/agent-profile)
- Address Books (https://developer.webex-cx.com/documentation/address-book)
- Idle codes (https://developer.webex-cx.com/documentation/auxiliary-code)
And many more.
Learn more on how to build a configuration management application powered by these configuration APIs using our samples below:
Reporting and Recording APIs
No Contact Center is complete without compliance recording and reporting and analytics. The Call Recording API (Captures API) allows you to retrieve call recordings securely from the platform for post-call analytics.
The reporting APIs on Webex Contact Center allow a developer to extract Contact Center reporting data. The reporting APIs today have 3 flavors of interfaces that can be leveraged to build a full-fledged reporting capability that supplements the Webex Contact Center solution.
Webhooks for Contact Center reporting
Webhooks form a great system for working with near-real-time data, and for reacting to Contact Center events using custom logic. If you want to stay on top of a busy contact center or have an application that can’t wait for slow batch reports or expensive API polling-and-diffing solutions, webhooks are the way to go:
- Real-time webhooks (https://developer.webex-cx.com/documentation/captures)
- Tasks Webhooks (https://developer.webex-cx.com/documentation/tasks)
- Agent Webhooks (https://developer.webex-cx.com/documentation/agents)
GraphQL Powered REST API
The Search API is a GraphQL (Graph Query Language) powered REST API that provides access to both historical and real-time raw data feeds. The API is called using and supports all the fields that are used by Webex Contact Center Analyzer reporting to store contact center data on the platform.
Look at our samples to learn more about how you can use our GraphQL API:
- Get started with GraphQL, see the GraphQL Sample (https://github.com/WebexSamples/webex-contact-center-api-samples/tree/main/reporting-samples/graphql-sample)
- To learn how GraphQL can be used to extract data used by a 3rd party solution, see the GraphQL PowerBI Sample (https://github.com/WebexSamples/webex-contact-center-api-samples/tree/main/reporting-samples/graphql-powerbi-sample)
REST APIs for Reporting
The following APIs provide interfaces with a stock set of fields to extract reporting data:
- Queue Statistics API (https://developer.webex-cx.com/documentation/queues)
- Agent Statistics API (https://developer.webex-cx.com/documentation/agents/v1/get-agent-statistics)
- Agent Activities API (https://developer.webex-cx.com/documentation/agents/v1/get-agent-activities)
To learn how these Reporting APIs can be used to extract data into a 3rd party Reporting Wallboard solution, see Wallboard Sample.
Create Agent and Supervisor Tools using Desktop APIs
The Contact Center Desktop for Agents and Supervisors is the application used to service contact center interactions. Although Webex Contact Center provides a fully loaded Agent and Supervisor Desktop, the Developer Portal surfaces all the APIs and technologies used to power this desktop.
The configuration APIs described above provide a way to list configurations on the desktop, such as Agent Profiles, Users, Idle Codes, Wrap up Codes, Address Books, and other settings used by an Agent or Supervisor.
Along with these, we provide a full set of Desktop APIs – both in REST and Websocket flavors bringing in the ability to build a fully integrated, 3rd party event-based desktop application.
The main APIs for an Agent function include:
- State Change
And the main APIs for Call control, are covered by the Call Control APIs:
And all these APIs can be found on the Agents Page.
This is supplemented by a full set of WebSocket notifications that can be subscribed to by using the Notification API.
- For a full set of web socket notification payloads, see the Contact Control APIs guide.
- Build a custom desktop using the Desktop APIs, see the Desktop API sample.