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
  • AI Assistant for Developers
  • Webhooks
  • Contact Center Sandbox
  • Using Webhooks
  • Troubleshoot the API
  • Beta Program
  • Webex Status API
  • Contact Center Service Apps
  • FAQs

Webex Contact Center

FAQs

Find answers to frequently asked questions about Journey Data Services.

anchorGetting Started

anchor

Q: Where can I Sign up to try the APIs? Do I need a Webex Login?

A: You can sign-up using a Webex account at Sign Up and create an App Integration.

Steps:

  • Login
  • Click your login persona / icon on the top right
  • Go to My Apps
  • Create an Integration

To manage the integration, regenerate keys, etc., you may use the same portal.

Q: Do I need a Sandbox to try these out? How do I get access to one?

A: Look at the section Sandbox for more information: Contact Center Sandbox

For additional queries, please send us an email at wxccdevsupport@webex.com or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new.

Today, Dedicated Instances are provided to our Technology Partners and Developer integrators.

To submit your interest to become a Developer Integrator, please fill this form:

To effectively use our APIs, you will need to have a Webex Contact Center enabled organization, access to Control Hub with Webex Contact Center licenses.

To access all the APIs, the user generating the token needs to be an Administrator.

Q: What Account do I need to use when signing in? Can I use ANY available Webex Login?

A: To “Try it out” on the Developer Portal, you will need to use a Webex Contact Center Administrator account.

To create an integration, you may use any account that is a Webex Common Identity account (Linked to Webex Control Hub).

Q: I have another App I have built on developer.webex.com for Meetings and Calling. Can I reuse the App for Contact Center?

A: Yes, you can reuse the same application. However, remember that to manage the application you will use the following portals:

For Webex Contact Center Apps > My Apps

Q: How do I create an App Integration? Where do I generate my Client ID and Client Secret?

A: You can sign-up using a Webex Common Identity account at https://developer.webex.com and create an App Integration.

Steps:

  • Login
  • Click your login persona / icon
  • Go to My Apps
  • Create an Integration

To manage the integration, regenerate keys, etc., please use the same portal.

Q: How to add users to Webex Contact Center?

A : Check if the user email id is already part of another organization, if yes, it should be deleted from that organization. You can also refer here for more details.

Q. Why am I not able to tryout the APIs in developer portal with agent role?

A: Most of the APIs work with admin role with scopes with cjp:config , cjp:config-read , cjp:config-write. Only a few APIs will work with agent role with scope cjp:user.

anchorTerms of Service / Legal Addendum

anchor

Q: Are there any specific Terms of Service for usage? Do we need to sign a Legal Addendum?

A: When you create an Application Integration, you implicitly and explicitly agree to the Terms of Service outlined along with the privacy policy. The Terms of Service do have implications that need to be reviewed by the developer creating and using our services. Please refer to the official documentation.

Terms of Service: https://developer.webex.com/terms-of-service/

Privacy Policy: https://www.cisco.com/c/en/us/about/legal/privacy.html

anchorDeveloper Portal & API Features

anchor

Q: Can I try out the APIs live? Anything Special that I need to do before I try these out?

A: Yes, you can “Try It Out” live after going to the developer portal and Signing In. However, please note the requirements before you can successfully run an API call.

The user you sign in with needs to have the minimum Read/Write Scopes for Contact Center required for the user:

cjp:config, cjp:config_read, cjp:config_write

For this, you will need to be a Webex Contact Center(WebexCC) account and have a Webex CC Administrator capability assigned.

For more details, refer:

https://help.webex.com/en-us/article/n5jdj19/Webex-Contact-Center-administrator-roles-and-privileges

Here is a quick list of scopes and their meanings

ScopeMeaning
cjp:configConfiguration Scope
cjp:config_writeConfiguration WRITE Scope
cjp:config_readConfiguration READ Scope
spark:people_readPeople READ Scope
cjp:userUser Scope
cjds:admin_org_readJourney Data Admin READ Scope
cjds:admin_org_writeJourney Data Admin WRITE Scope

Q: What is the format for timestamps to be sent to the API? How can one work with these timestamps?

A: The timestamps follow the Epoch (Unix/Posix) time.

It is in milliseconds since Jan 1 1970. All libraries have native support for this.

For example, in javaScript/node you can use:

new Date(‘2022-01-01').getTime();

Q: How can I use Webhooks for Webex Contact Center?

A: We provide a Subscriptions API collection to manage Webhooks.

We have several endpoints that support webhooks. Tasks, Captures, Agents, for example. To subscribe to a webhook event, your application must be reachable via the public internet. For protected applications behind a firewall, please use a reverse proxy application.

For security settings for your Webhooks, refer to: https://help.webex.com/en-us/article/3srgv1/Set-up-security-for-Webex-Contact-Center

Q: What Webhooks are Supported Today? Will more be added in the future?

A: Please refer to our documentation under Tasks, Captures and Agents. We will add more Webhooks in the future under the API documentation.

Q: Does Webex Contact Center support GraphQL out of the box? What features are supported?

A: Our Search endpoint supports GraphQL natively with an interactive editor powered by GraphiQL

https://developer.webex.com/docs/api/v1/search

A simple query, like fetching all the Tasks from a specific date/time and returning only the task ID would look like this:

{task(from:1635750000000) {tasks{id}}}

Much more complex queries can be formulated including with fields and functions like min,max,avg,sum etc.

Please refer to the API samples located on our GitHub page for more information – Look at “reporting-samples” for more GraphQL examples.

https://github.com/WebexSamples/webex-contact-center-api-samples

Q: Can we retrieve call recordings from Webex Contact Center? Is there an example?

A: Yes, you can retrieve call recordings using the Captures endpoint.

To call the Captures endpoint, you will need to use the Tasks or Search endpoint to get the task Ids first, and then POST a request, 10 tasks at a time.

The sample is available on GitHub. Refer to the “recording-samples” for more information.

https://github.com/WebexSamples/webex-contact-center-api-samples

Q: Can we retrieve reporting data from Webex Contact Center? Is there an example?

A: The following reporting APIs are available today.

  • Queue Statistics
  • Agent Statistics
  • Agent Activities
  • Search
  • Tasks

We continue to add more schema types under Search (GraphQL) as well as adding RealTime WebSocket APIs for Webex Contact Center.

The sample is available on GitHub. Refer to the “reporting-samples” folder

https://github.com/WebexSamples/webex-contact-center-api-samples

Q: Can we retrieve real time data from Webex Contact Center? Is there an example?

A: You can use the Search endpoint today to poll for “Active” contacts in the contact center. We are adding Agent Sessions to the Search endpoint as well.

The sample is available on GitHub.

For other use cases, Real time streaming APIs using WebSockets are still in progress. WebSocket APIs are still under development.

Q: Do we have Real time “Media Streaming” APIs for Webex Contact Center? We want to externalize ASR/TTS/STT (Automatic speech recognition / Text to Speech / Speech to Text)

A: Today these APIs are not yet available. They are still in the backlog.

Q: Can we manage, and control Contacts/Calls on Webex Contact Center? Is there an example?

A: Today, these APIs are still under development. They will be released later this year.

Q: Can we manage and control Agents on Webex Contact Center? Is there an example?

A: Yes, we have Desktop APIs that are available. You can try out the Desktop API Samples available on Github.

Q: Are there Monitoring APIs available on Webex Contact Center?

A: These are on the roadmap.

Q: Are there resources to learn more about REST, gRPC, GraphQL, Webhooks, and the underlying technologies powering the APIs? How does one get started?

A: There is plenty of online material available for the basics of the technologies that power these APIs. For starters, one can look at the open-source content available at Mozilla Developer Network. Here are the specific pages for the specific technologies:

Understand OAuth2 : https://oauth.net/2/

APIs: https://developer.mozilla.org/en-US/docs/Web/API

https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Client-side_web_APIs/Introduction

GraphQL: https://graphql.org/learn/

Webhooks: https://requestbin.com/blog/working-with-webhooks/

Q: Does the WebexCC Gold Tenant allow partners to test/try the APIs?

A: Yes, the Webex Contact Center Gold Tenant can be used to test our APIs. Please note that since these are deployed in production, general client-side rate limits apply. Clients can expect a 429 Too Many Requests and will need to implement a backoff mechanism. Rate limits are imposed on a Client ID level. For more information about Rate limiting, refer:

https://developer.webex.com/docs/rate-limiting

Q: What APIs are available today for Digital Channels? For Email / Chat / Social integrations?

A: For our New Digital Channels, we have the API docs available at https://developers.imiconnect.io/reference

These APIs are separate from our Webex Contact Center APIs. Every Webex Contact Center tenant is provisioned with the Webex Connect tenant with the Control Hub. One must use the administrator account configured on the Webex Connect instance to try out the APIs.

Q: Are there APIs for Injecting a Contact (Task / Chat / Email) into the Webex Contact Center?

A: The Task API is currently available internally, and the external API specification will be published soon to the developer portal.

Q: The Current APIs can be used for Historical data queries. Can we use them for real-time events as well?

A: The real-time reporting API specification using WebSockets is currently being developed and will be published soon to the developer portal.

However, to search for active Tasks or Agent Sessions in the Contact Center, you may use the Search endpoint, which gives you the currently active Contacts/Agents

https://developer.webex.com/docs/api/v1/search/search

anchorApp Management

anchor

Q: The person who was building the integration has left the company. Can I transfer ownership of the App?

A: Please email us at wxccdevsupport@webex.com or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new for guidance on the next steps.

To avoid any issues with orphaned integrations, please try to register integrations with a developer account that is owned by an organization, and with which credentials can be shared amongst a team of stakeholders. If the organization has limitations on user emails, an org can create a dummy email address using a service like Gmail, then create a free Webex account, and log into the Webex Contact Center Developer portal with the new account and register the integration once sharing the details to this new developer account with all stakeholders. The idea here is to remove a single access point to an integration.

If an integration does become orphaned, and access is lost, please open a support case at https://developer.webex.com/support. Alternatively, if the application cannot be recovered and the original code base is accessible, recreate the integration under another developer account in the developer portal and replace the ClientID and Client Secret in the code base to reflect the new integration.

Q: Does my Integration Break if the Owner leaves the Company? Will my App Continue to run?

A: Yes, your app will continue to run if the original Control Hub account is deleted. Ownership of the person’s app is transferred to Control Hub. Please reach out to Developer Support. If you need help in transferring the ownership of your app integration. We recommend using Service apps

Q: Does my Integration break if the admin whose access_token I used, leaves the Company? Will the access token continue to remain valid?

A:Yes, since the integration depends on the Account, you will need to reconfigure the integration using another account. No, your access_token will not remain valid.’

Q: How do we create a Webex Contact Center Sandbox ?

A: Please refer to the steps mentioned here: Contact Center Sandbox and also refer to this vidcast on how to create a Sandbox environment.

anchorAPI Ecosystem

anchor

Q: We are using Post Call Survey with WebexXM (Webex Experience Management). What APIs are available for WebexXM? Is it the same process to get access?

A: WebexXM technical API documentation is available at https://xm.webex.com/docs/dev/. The product documentation is also available in the same portal https://xm.webex.com/docs/

The API specification can be found on the Swagger docs: https://xm.webex.com/explore#/explorer. Anyone with a valid user ID and password can use swagger to explore our APIs.

Q: We are using Digital Channels powered by IMI. What APIs are available for IMI? Is it the same process to get access?

A: The New Digital Channels API Documentation is located at: https://developers.imiconnect.io/reference#sandbox-apis-overview

The process to obtain API access to our Digital Channels is currently different. Please contact your Cisco CSM/PSM, email us at wxccdevsupport@webex.com, or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new for more information.

Q: We are using Customer Journey Data Services. How do I integrate with CJDS/CJaaS? Is it the same process to get access?

A: The Journey Data Services API Documentation is located at:

https://cjaas.cisco.com/home#resource-section

The Journey Data Service requires separate access tokens to be generated using the Admin portal at: https://cjaas.cisco.com/admin

For more information, refer to the CJDS site: https://cjaas.cisco.com

Q: I want to use the AI APIs for WebexCC (gRPC). How do I integrate? Is it the same process to get access?

A: The AI APIs are still in the works for Webex Contact Center. They are currently only available for WebexCCE customers and for on-premises use cases.

Please email us at wxccdevsupport@webex.com or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new if you have a specific use case that requires the gRPC powered AI APIs for WebexCC.

Q: I am a Developer Partner and have built an application already. How do I on -board a New Customer with these APIs?

A: You will need to have your Customer Administrator “Onboard” their organization on your Application. You application will maintain the access_token, refresh_token and org_id for the authentication flow and this one-time onboarding is required for the customer to be able to use your application with our APIs.

Q: We are using Webex Calling Endpoints for our Agents. Are there APIs for Webex Calling that we can use? What is the process and is there documentation?

A: The Webex Calling APIs are located at developer.webex.com and the API documentation and specification is located there under the API reference.

https://developer.webex.com/docs/webex-calling-overview

anchorDiscovery & Availability

anchor

Q: Where can I find API Documentation and the list of APIs?

A: You can find all the APIs for the New Webex Contact Center on https://developer.webex.com

These APIs are not applicable for Webex Contact Center 1.0

Q: Are there Realtime Voice Streaming APIs for Webex Contact Center? What Technology/Interface do these use?

A: Today, we do not have Real-time voice streaming capabilities on the platform. These are still in the immediate roadmap. They are due to be delivered end of CY22.

Q: Are APIs available for Webex Contact Center in all Regions? Can I use the developer portal for all regions?

A: Yes, both the Developer Portal and the individual APIs are available in all regions. The Developer Portal is available at https://developer.webex.com and the individual APIs are available at region specific URLs. Please use the following table to map the API endpoints.

Table 1

RegionAPI
UShttps://api.wxcc-us1.cisco.com
ANZhttps://api.wxcc-anz1.cisco.com
UKhttps://api.wxcc-eu1.cisco.com
EU (Frankfurt)https://api.wxcc-eu2.cisco.com
Japanhttps://api.wxcc-jp1.cisco.com
Canadahttps://api.wxcc-ca1.cisco.com
Singaporehttps://api.wxcc-sg1.cisco.com

Q: What are the Developer Portal URLs per datacenter?

Developer Portal is globally available at https://developer.webex.com

Q: What are the API endpoints per datacenter?

A: Please refer to Table 1.

Q: Where can I find the links to register to the Power-Up webinars and the slides/recordings of the previous webinars?

A: We are continuously working on content for developers. The previous power-up webinar can be found at https://golearn.webex.com. Additional sessions will be posted there. Upcoming sessions will be notified via email.

https://community.cisco.com/t5/webex-contact-center-documents/webex-contact-center-continuous-education-power-up-schedule/ta-p/4043806

https://golearn.webex.com/learn/catalog/view/115

Q: Where can I find the roadmap of upcoming APIs and Timelines?

A: The Roadmap for all the upcoming APIs and Timelines are published on a quarterly basis on Sales Connect. Please contact your CSM/PSM or Cisco Contact for access to this resource.

For what’s coming soon, please look at the Coming Soon section on our “What’s New in Webex Contact Center page”: https://help.webex.com/en-US/article/a1gx3h/What's-New-in-Webex-Contact-Center#topic_D8159C942D4EE10D3C86F7C043C86722

Q. How do we receive desktop notifications like Login, Logout, State Change, etc? Do we have a Websocket endpoint to subscribe to?

A: Webex Contact Center provides a Websocket notification endpoint to receive desktop notifications. It is called the Notifications API.

Here is the API: https://developer.webex.com/docs/api/v1/notification

To understand the payload of the Websocket Events, please refer this doc on how to register to a websocket connection and check out all the possible notification payloads that you receive here

https://developer.webex.com/docs/contact-control-apis

Q. Where can I find the information on rate limiting? / How to increase the rate limiting to my org? / Why am I getting HTTP 429 as Response?

A: Webex Contact Center APIs enforce a rate limiting per client ID integration.

You can fetch more information here. You can reach out to us to increase the rate limits for your org.

APIs and Specifications

Q: Where can I find documentation on Search endpoint?

A: Below is the documentation link for Search API .

https://developer.webex.com/docs/api/v1/search/search

  • Open above link
  • Go to the Try Out section
  • Maximize the screen
  • Open the docs
  • Click on Query, you will see all the schemas which Search query support- task, taskDetails, agentSession etc

Also, you can refer below link for GraphQL Samples.

https://github.com/CiscoDevNet/webex-contact-center-api-samples/tree/main/reporting-samples/graphql-sample

Q. How do we upload Audio Files into Webex Contact Center programmatically?

A: We have a Create Audio API on Webex Contact Center

https://developer.webex.com/docs/api/v1/audio-files/create-a-new-audio-file

You can use the Devportal’s Try-Out section for the Create API which is a POST Audio File API.

But if you want to try using Postman, then it is not possible as the curl command is not updated yet.

You can refer the below curl command for creating an Audio file.

curl --location '[https://api.wxcc-us1.cisco.com/organization/\u003Corg_id](https://api.wxcc-us1.cisco.com/organization/<org_id)>/audio-file'  \\
--header 'Accept: */*'  \\
--header 'Authorization: Bearer YOUR_TOKEN'  \\
--form '[audioFile=@\"/Users/\u003Cname>/Desktop/defaultmusic_on_hold3.wav](mailto:audioFile=@"/Users/<name>/Desktop/defaultmusic_on_hold3.wav)\"'  \\
--form 'audioFileInfo=\"{\\\"contentType\\\":\\\"AUDIO_WAV\\\",\\\"name\\\":\\\"defaultmusic_on_hold3.wav\\\"}\";type=application/json'

Q. How can I calculate the Opt-Out metric using the GraphQL API Task data?

A: The GraphQL API provides a lot of fields inside of every object. For the Task Object you can get a list of fields in the Try Out > Docs section.

One can use the filter on isOptOutOfQueue field in taskDetails query to fetch data.

Here is an example of such a filter on the Task objects: [https://github.com/CiscoDevNet/webex-contact-center-api-samples/tree/main/reporting-samples/graphql-sample/taskDetails/Samples for Raw Data Fetching](https://github.com/CiscoDevNet/webex-contact-center-api-samples/tree/main/reporting-samples/graphql-sample/taskDetails/Samples for Raw Data Fetching)

Q. Is there a known field Mappings for GraphQL endpoint?

A: [GraphQL_Metrics and Descriptions - Call and Agent-1.xlsx](https://confluence-eng-sjc12.cisco.com/conf/download/attachments/312322668/GraphQL_Metrics and Descriptions - Call and Agent-1.xlsx?version=1&modificationDate=1689269614380&api=v2)

Q. How to fetch TaskLegDetails ? / TaskLegDetails query did not fetch any data?

A: This feature is still under development.

Q. Why is copy to clipboard failing in Webex CC Desktop iFrame?

A: Adding the "allowedParams" attribute as either "clipboard-read; clipboard-write" or "clipboard-read; clipboard-write self ${URL}" enables clipboard read and write operations within the iframe. You can find an example here.

Q. How can I change the userProfileId of a user programmatically with this endpoint; https://developer.webex.com/docs/api/v1/users/update-specific-user-by-id

A: Currently, changing the profile type for a user is only supported from Cisco Webex Control Hub and requires a token with FLS:Read_Scope scope.

Q. Where can I find information about building a custom widget?

A: This guide should be able to help you get started on how to build a custom widget.

Q. Does the destinationUrl field in the Register Subscription API support URL redirection?

A: It is not supported currently. Webhook will be posted to the mentioned URL for the API https://developer.webex.com/docs/api/v1/subscriptions/register-subscription

anchorAuthentication

anchor

Q: What Authentication and Authorization mechanism do you support with Webex Contact Center?

A: We currently support OAuth2 with the Authorization Code grant type. This means that we require Form Based authentication (User interface) at the time of generating the first access_token and refresh_token. The user is asked to enter their username and password for the OAuth2 Grant flow to complete. Subsequent tokens can be requested and refreshed from the backend without the user interface.

Q: What Authentication and Authorization Mechanisms are supported for backend apps that need to connect to Webex Contact Center?

A: We currently support OAuth2 with the “Authorization Code” grant type. We do not yet support Password Grant or client credentials (service to service grant types).

Today, to connect to Webex Contact Center, you can build a token management service that refreshes the tokens to maintain perpetual access to the system. Initial setup for the authentication will require a user to fill in their credentials. Subsequent refreshes will require the service to make those backend calls.

Q: What are the OAuth2 Grant types supported today? Do you support Machine accounts today?

A: We currently only support OAuth2 with the “Authorization Code” grant type. This means that we require Form Based authentication (User interface) at the time of generating the first access_token and refresh_token. We do not support machine accounts today.

Q: What are the minimum scopes I need to work with the Webex APIs? How does a user get granted these scopes?

A: The minimum scopes to read and write on the APIs are cjp:config, cjp:config_read and cjp:config_write.

These scopes will provide you with read/write to our core API endpoints. Note that other services, such as AI, require additional scopes. Please refer to the API Documentation for more information.

Q: What is the expiry of the access_token and refresh_token? Can this be changed?

A: The access_token is valid for 12 hours. The refresh_token is valid for 60 days starting from when the OAuth2 Grant was completed.

Q: What is the difference between the access_token and refresh_token?

A: The access_token is to be used in the Authorization header of the call.

The refresh_token is used with the “Refresh Token” grant type when a new access_token needs to be requested.

For more information on OAuth2 refer to https://oauth.net/

Q: How do I rotate my App Secret? Is this App Integration tied to a user?

A: You will need the owner of the Integration to login to https://developer.webex.com and go to Sign In > Manage My Apps > and then click to rotate the Application’s Client Secret.

The Client ID is unique per integration and cannot be changed – it is what identifies your integration.

Q: How do we create OAuth access token and create integration?

A: Please follow the steps mentioned in this vidcast for generating the access token.

Q. How can we invalidate the access_token and refresh_token?

A. Access_token & refresh_token that's been issued to your app may be invalidated as a result of changes to a user's account.

A user's account access changes as a result of updates to their email address or password.

A user's Webex organization administrator deactivates and reactivates their account.

Q. What is the maximum number of active access_token a user can have at a given point of time?

A: A user is allowed to have up to 750 active access tokens at a given time.

anchorPlatform / Other

anchor

Q: Do you avoid downtime during production updates for APIs?

A: We are cloud native and currently have rolling deployments which avoids downtime. Clients will not notice any impacting changes during our deployments. If, however, we need to schedule changes that require a maintenance window, we will use regular channels as per our change management process.

Q: If you utilize downtime deployments, what is the average duration that you aim for?

A: We do not aim to cause any downtime to our client applications.

Q: Do you have any published SLAs or Latency metrics per endpoint?

A: We currently do not publish our external SLAs per endpoint. We are working on getting these published soon. For more specific queries please send us an email at wxccdevsupport@webex.com or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new.

Q: Can MFA be used to access all APIs?

A: We use Webex Common Identity that inherently supports MFA features using OAuth2. Since we use the authorization_code grant flow this uses the standard OAuth2 with applicable MFA configured. The APIs will still use the access_token generated after the authentication.

Q: Does the application cross-reference an IP allow-list dedicated to sources of authentication requests?

A: We do not explicitly maintain a client level allow-list. Our APIs are publicly accessible to anyone over the internet. If you have a specific use case that needs this, please send us an email at wxccdevsupport@webex.com or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new

Q: Which API use-cases do you support? Server to server, Server to server via service accounts which would have elevated privileges compared to user accounts OR End user authorized and provides authentication?

A: We currently only support OAuth2 with grant type authorization_code. The initial onboarding requires an access_token that is generated via a login form. This requires form-based authentication with a user interface. Subsequent logins can use refresh_tokens to ensure backend access is maintained. We have sample code that explains this. The sample code is in our GitHub repository.

Q: Are credentials issued for your API subject to an expiration policy?

A: Yes, for integrations created prior to January 16, 2024 the access_token is valid for 12 hours and refresh token is valid for 60 days. For integrations created after January 16, 2024 the access_token is valid for 14 days and refresh token is valid for 72 days. Please refer to the authentication section for more information: https://developer.webex.com/docs/authentication-cc.

Q: Can the expiration policy be changed?

A: Yes, please create a support ticket if you would like to request a change in these values: https://developer.webex.com/support.

Q: Does your API offer a role-based API access feature? If so, please describe the level granularity achievable: Endpoint specific, Method specific and Read/Write.

A: Yes, we support all the levels of granularity. On the account level, the scopes decide the read/write and endpoint level controls. The user profiles tied to the licenses decide the role- based access control. For example, agents cannot access the Captures endpoint for call recordings. However, Supervisors and Admins can. This is reflected in the scopes and entitlements assigned to the user, and verified while using the APIs.

Q: Do you provide visibility into the access logs of the API for the account you would provide us? If so, please give a description.

A: Not today. We provide enough debugging information through the client-side responses. We do maintain server side and access logging which are available via Cisco TAC.

Q: Are those logs exportable for audit purposes? If so, please describe by which means: API, Web portal or requested and sent by email.

A: For logging we store the logs for 30 days and follow other compliance guidelines for archival. Please reach out to Cisco TAC for more information regarding access to server-side logging.

Q: Does your API use rate limiting? If Yes, what is the limit?

A: We currently throttle requests using the Client ID and have fixed rate limits per Client ID. Clients will receive a 429 Too Many Requests when throttled, with a “retry-after” interval in seconds. For more information, refer: https://developer.webex.com/docs/rate-limiting

To increase the rate limit or discuss your use case specifically, please email us at wxccdevsupport@webex.com or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new

anchorDeveloper Partner

anchor

Q: I am a Developer Partner and want to allow my customers to Try my App. Is there a Developer Marketplace or App Hub for my new App?

A: We are working on making the Webex Contact Center App Hub publicly available. If you are interested in participating the showcase, please email us at wxccdevsupport@webex.com or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new

Q: What is the criteria to get on the Developer Showcase? How do I do this?

A: We have a specific criteria to be able to showcase your App on the developer marketplace. For more information, please email us at wxccdevsupport@webex.com or submit a request here: https://devsupport.webex.com/hc/en-us/requests/new

In This Article
  • Getting Started
  • Terms of Service / Legal Addendum
  • Developer Portal & API Features
  • App Management
  • API Ecosystem
  • Discovery & Availability
  • Authentication
  • Platform / Other
  • Developer Partner

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.