How APIs work in Genesys Engage cloud

Learn about the APIs you can use to customize your applications and integrate with Genesys.

APIs in Genesys Engage cloud fall under two categories: Web APIs that your web application accesses through Genesys Engage cloud and JavaScript APIs that you install in a location your web application can access.

Web APIs

Web APIs are documented on the Genesys Engage cloud Developer Center, where you can find reference information, tutorials and samples. Genesys recommends that you are familiar with OAuth 2 - Genesys Engage cloud web APIs implement this standard for secure authentication and support the Authorization Code Grant type. Check out the Authentication API for details.

See below for a complete list of web APIs and links to related documentation.

Authentication API

Provides OAuth2 authentication and authorization.

• API reference
• Client libraries
• Engage/authorization-code-grant-sample-app Sample application

CX Contact Service API

Create and manage outbound campaigns, import and work with contact lists, and enable compliance rules.

• API reference

Consumer Messaging API

Create a session, send and fetch messages, and manage participants.

• API reference

Data Download Service API

Securely export your contact center data.

• API reference

Engagement API

Manage callbacks, query availability, estimated wait times, and create call-in requests.

• API reference
• Client libraries
• Tutorials

Intelligent Workload Distribution API

Create, update, delete or find workitems that come from third-party applications.

• API reference

Provisioning API

Configure your Genesys environment, create users, and retrieve configuration data.

• API reference
• Client libraries
• Tutorials

Statistics API

Subscribe to statistics and get notifications when they change.

• API reference
• Client libraries
• Tutorials

Task Routing API

Submit workitems to Genesys from third-party applications.

• API reference

Workspace API

Manage agent state, access to voice and chat channels, and supervisor monitoring.

• API reference
• Client libraries
• Tutorials

JavaScript APIs

Documentation for our JavaScript libraries is on this site and includes reference information, as well as how to download and get started with the APIs. See the sections below for details.

Service Client API

Extend the UI integration when Agent Desktop is configured to embed other web client business applications.

• Get started
• API reference

Widgets

A collection of JavaScript APIs that provide UIs (and their supporting services) you can use in your own web applications. For example, chat and co-browse.

• Deployment
• API reference