CreateBlogSupport
Log inSign up
Home
Webex Contact Center
  • Overview
  • Guides
  • API REFERENCE
  • AI
  • Configuration
  • Data
  • Desktop
  • Journey
  • Media And Routing
  • Changelog
  • SDK
  • Customer Journey Data Service
  • Webex AI Assistant for Developers
  • Webhooks
  • Contact Center Sandbox
  • Using Webhooks
  • Beta Program
  • Webex Status API
  • XML API Deprecation

Webex Contact Center

Bring your own Virtual Agent

As part of the "Bring Your Own" (BYO) initiative, Webex Contact Center aims to enable seamless integrations with third-party AI providers, enhancing the Webex customer experience with cutting-edge AI innovations. Bring your own Virtual Agent is the first slice of all other other AI functionalities you can bring to Webex Contact Center product offerings.

anchorWhat is a Voice Virtual Agent?

anchor

In essence, a Voice Virtual Agent interacts with callers during voice calls and performs the following key functions:

  1. Transcribes the caller's speech to text for AI processing.
  2. Utilizes Natural Language Understanding to identify the caller's intent.
  3. Maps the identified intent to an existing workflow (OR) uses Generative AI to create a text response.
  4. Converts the generated text to speech which is then prompted to the caller back.
  5. For escalated calls, provides the human agent with context by supplying the Virtual Agent's transcript or a summary.

VA-flow

Fig 1: A sample Virtual agent call that is escalated to a human agent

anchorPhase 1 - Development

anchor

Dialog Connector Simulator

VA-flow

Fig 2: Architectural Diagram for provisioning an Virtual Agent

The Dialog Connector Simulator is a sample Java application that demonstrates how to integrate an external conversational interface with Webex Contact Center IVR. Refer to the Dialog Connector Simulator Sample Code for guidance.

All media from Universal Harness (media platform) is streamed using gRPC APIs, and the Virtual Agent APIs use bidirectional streaming to send and receive media from the 3rd party provider.

  1. Start by getting yourself a Webex Contact Center Sandbox.
  2. Request Voice Virtual Agent entitlements via developer support.
  3. Go through the protobuf definition.
  4. Sample Code: https://github.com/CiscoDevNet/webex-contact-center-provider-sample-code

Catch the code walkthrough demo here: https://app.vidcast.io/share/41f3d470-07cc-412d-bd50-d5c9e00d3183?playlistShareId=1f4a2dff-8be4-4dd5-a1fb-d5aae8441bd3&autoplay=1

Note: Start testing in the cloud sandbox, and the same service app can be used for testing on a CCE test setup for validation.

anchorPhase 2 - Authentication

anchor

Authentication is set up using “Bring Your Own Data Source,” which gives developers the flexibility to register a unique URL and a token for every customer they onboard. Developers can create a Service App to start using the Voice Voice Agent schema.

Service App creation and authorization

Step 1: Login to the developer portal via a sandbox user credentials (You can recreate a service app later in your official webex account). Create a Service app with spark-admin:dataSource_read/dataSource_write scopes.

image

Step 2: For connecting to your Voice Virtual Agent application, choose the voice virtual agent schema in the "Data Sources" section. Also add the domain of the URL to which the connection should be established in the "Data Exchange Domain. For Eg. if the connection must be established for the URL (www.virtualagent.cisco.com), enter (cisco.com) :

image

Step 3: After creation, you need to submit your app to the customer org admin for authorization:

image

Important Links

  1. Service App: https://developer.webex.com/docs/service-apps
  2. Bring Your Own Data Source: https://developer.webex.com/create/docs/bring-your-own-datasource
  3. BYODS SDK: https://www.npmjs.com/package/@webex/byods
  4. Demo of Bring your own Data Source: https://app.vidcast.io/share/bce964f2-4162-4467-9538-af5570176933
  5. Mutual TLS: Coming Soon

anchorPhase 3 - Customer Configuration

anchor

To use the service app created, follow these onboarding steps:

  1. Org admin authorization and data source registration: A user with organization or contact center admin role (you can login to (www.admin.webex.com) with the admin credentials of your sandbox) needs to authorize the app by going to Control Hub -> Apps.

    Service App

    As the provider, you must register the data source using an authorized service app's token which can be generated by going to your service app and choosing Generate Token for the customer org by selecting the org from drop down in the developer portal.

  2. Config creation: Once the service app is authorized and a data source is registered, navigate to Main Menu -> Contact Center -> Integration -> Features:

    CCAI Config

  3. Flow Creation: Create a flow with the Virtual Agent Voice Activity and use the AI configuration you created above in the Flow Control UI.

    Flow Designer

  4. Entry Point Mapping: Map the EntryPoint to the newly created flow (Contact Center -> Channels -> Entry Point)

    Entry Point Mapping

After these steps, make a call to the phone number specified in the entry point via your cell phone or Webex Calling Extension for Chrome if you are not in the US or Canada.

anchorPhase 4 - App Hub Submission Process and Review

anchor

All marketplace vendors need to go through the App Hub Submission Process. Once you have submitted the app for review, the application will be reviewed against these test cases:

ThemeDescriptionPriority
Service AppService app must be created with a mailer email ID that can be accessed by multiple users in the organizationOptional
Must provide onboarding documentation for customersMandatory
Support emails, links and documentation must be provided. SLAs for all issues must be mentioned.Mandatory
Bring your own Data SourceData Exchange Domains registered must be owned by the service app owner. Testing the application on a 3rd party hosting service is permitted but must switch over to a domain that's owned by the service app owner.Mandatory
Demostrate logic to generate unique nonce for every customer onboarding the app.Mandatory
The logic to decrypt the JWS token received from: US Public Key or EU Public KeyMandatory
Update the nonce for the JWT token at least once every 1440 minutes (24 hours)Mandatory
Customer SetupThe customer would have to buy 3P-Virtual-Agent SKU to enable your service appMandatory
Customer must be able to discover and authorize your Service AppMandatory
Once the app is authorized, the data source must be registered automaticallyMandatory
Create a "Feature" by navigating to "Contact Center -> Integrations -> Features" and creating a CCAI Config pointing to the Service App created by you.Mandatory
The CCAI Config should contain all the required fields necessary for the customer to connect to the project on the AI Vendor's portalOptional
Routing LogicThe customer must be able to configure the "Virtual Agent V2" activity in the flow designer or "VVA Element" in call studio, which points to the CCAI Config created.Mandatory
Health CheckThe server must send back the serving status as “SERVING” or “NOT_SERVING” while Cisco initiates Ping Tests. Look here for sample implementationMandatory
Call EventsThe call must receive and respond to “CALL_START” event when the call is initiated from the entry pointMandatory
The Virtual Agent must be able to respond to the caller with a permissable latency of 200 to 500 msMandatory
The call must end with "CALL_END" event. Showcased via the "debug" tab in the flow designerMandatory
The call must be escalated to a queue of human agents with "AGENT_TRANSFER" eventMandatory
The caller must be able to interupt the Virtual Agent with "BARGE_IN" eventOptional
The Virtual Agent must be able to process DTMF tonesOptional
Send custom events, such as vendor config data or call associated data from the flow designer/call studioOptional
Post Call EventsThe Virtual agent call must initiate and terminate at the flow designer in the "Virtual Agent V2" activityMandatory
Pass along the Virtual Agent transcript to the agent desktop using custom widget for Webex Contact CenterMandatory
Pass along the Virtual Agent transcript to the finesse using custom gadget for UCCE, PCCE and CCEMandatory
Pass along any other insights to the agent desktop such as Virtual Agent Summary, Status or Sentiment ScoreOptional
In This Article
  • What is a Voice Virtual Agent?
  • Phase 1 - Development
  • Phase 2 - Authentication
  • Phase 3 - Customer Configuration
  • Phase 4 - App Hub Submission Process and Review

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2025 Cisco and/or its affiliates. All rights reserved.