Web Services API Reference

RESTRICTED

Important

This is restricted release documentation, and therefore is subject to change and is not complete. Some features that are described in this documentation might not be fully implemented in the application.

Welcome to the Web Services Application Programming Interface (API) Reference.

This API Reference covers all the resources and methods available to developers through the Genesys Web Services API Reference.

Each subcategory presents information about relevant operations, related resources, Request parameters and Return values.

General

• What Are Operations?
• What Are Capabilities?
• Agent State Operations
• Asynchronous Events
• Error Handling
• Recovering Existing State
• Working With Settings

• Toast And Case Data
• Disposition codes
• RequestTypes
• ReturnValues
• Subresources
• Filtering
• Features
• Services

Voice API

• Overview
• Calls
• Call Forwarding
• Conferences and Transfers
• Attached Call Data

Voice API - Other

• Agent State
• Supervisor Activities
• Call Recording
• Session Management

Interactions API

• Overview
• Chat
• Email
• Workbins
• Standard Responses

Channels API

• Overview
• Query Agent State
• Set Agent State Across All Channels
• Set Agent State For A Particular Channel
• CometD Notifications

Provisioning API

• Overview
• AgentStateOperations
• Devices API
• Features
• Queues API
• Skills API
• Users API

Contacts API

• Overview
• Contacts Attributes
• Contacts operations
• Examples

Settings API

• Overview
• Operations
• Attributes
• Example
• Supported Settings
• User-Defined Supported Settings

Statistics API

• Overview
• List of Statistics to be monitored