Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
Line 2: Line 2:
 
__NOTOC__
 
__NOTOC__
  
−
==<span STYLE="color:red;">RESTRICTED</span>==
+
{{RestrictHeader}}
  
−
<!-- Available styles: (default)-Important, 2-Tip, 3-Warning -->
+
==Overview==
−
<!-- Important: equal signs (=) will not work in a note. Use the equivalent HTML code (&#61;) instead.-->
+
Welcome to the Genesys Web Services Application Programming Interface (API) Reference.  
−
{{NoteFormat|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.}}
 
  
 +
This Genesys Web Services REST API can be used to write agent applications that provide a variety of contact center-related features. These features include agent state management, call control, supervisor monitoring, and call recording.
  
−
Welcome to the Web Services Application Programming Interface (API) Reference.  
+
This reference explains the resources and methods available to developers.  
  
−
This API Reference covers all the resources and methods available to developers through the Genesys Web Services API Reference.
+
Each category presents information about relevant operations, related resources, request parameters, and return values.  
  
−
Each subcategory presents information about relevant operations, related resources, Request parameters and Return values.
+
<div class="itemcontainer">
  
−
<div class="map-box">
+
<!-- -------------- -->
−
====General====
+
<!-- START DOCUMENT -->
−
*[[WhatAreOperations|What Are Operations?]]
+
<div class="item">
−
*[[WhatAreCapabilities|What Are Capabilities?]]
+
<div class="bookitem">
−
*[[AgentStateOperations|Agent State Operations]]
+
[[General|General (<i>restricted</i>)]]
−
*[[AsynchronousEvents|Asynchronous Events]]
+
Concepts employed by the various portions of the Genesys Web Services REST API.
−
*[[ErrorHandling|Error Handling]]
 
−
*[[RecoveringExistingState|Recovering Existing State]]
 
−
*[[WorkingWithSettings|Working With Settings]]
 
 
</div>
 
</div>
 +
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
+
<!-- -------------- -->
−
==== ====
+
<!-- START DOCUMENT -->
−
*[[ToastAndCaseData|Toast And Case Data]]
+
<div class="item">
−
*[[DispositionCodes|Disposition codes]]
+
<div class="bookitem">
−
*[[RequestTypes|RequestTypes]]
+
[[VoiceAPI|Voice API (<i>restricted</i>)]]
−
*[[ReturnValues|ReturnValues]]
+
API for developers building voice-related client applications.
−
*[[Subresources|Subresources]]
 
−
*[[Filtering|Filtering]]
 
−
*[[Features|Features]]
 
−
*[[Services|Services]]
 
 
</div>
 
</div>
 +
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
+
<!-- -------------- -->
−
====Voice API====
+
<!-- START DOCUMENT -->
−
*[[VoiceAPI|Overview]]
+
<div class="item">
−
*[[Calls|Calls]]
+
<div class="bookitem">
−
*[[Call Forwarding|Call Forwarding]]
+
[[MultimediaAPI|Multimedia Interactions API (<i>restricted</i>)]]
−
*[[ConferencesAndTransfers|Conferences and Transfers]]
+
API for developers building multimedia-related client applications.
−
*[[CallData|Attached Call Data]]
+
</div>
 
</div>
 
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
+
<!-- -------------- -->
−
====Voice API - Other====
+
<!-- START DOCUMENT -->
−
*[[AgentState|Agent State]]
+
<div class="item">
−
*[[Supervisor|Supervisor Activities]]
+
<div class="bookitem">
−
*[[CallRecording|Call Recording]]
+
[[ChannelsAPI|Channels API (<i>restricted</i>)]]
−
*[[SessionManagement|Session Management]]
+
API for developers building applications that use channels.
 +
</div>
 
</div>
 
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
+
<!-- -------------- -->
−
====Interactions API====
+
<!-- START DOCUMENT -->
−
*[[MultimediaAPI|Overview]]
+
<div class="item">
−
* [[Chat|Chat]]
+
<div class="bookitem">
−
* [[Email|Email]]
+
[[ProvisioningAPI|Provisioning API (<i>restricted</i>)]]
−
<!-- * [[Facebook|Facebook]] -->
+
API for developers building applications that require provisioning.
−
<!-- * [[Twitter|Twitter]] -->
 
−
* [[Workbins|Workbins]]
 
−
* [[StandardResponsesAPI|Standard Responses]]
 
 
</div>
 
</div>
 +
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
+
<!-- -------------- -->
 +
<!-- START DOCUMENT -->
 +
<div class="item">
 +
<div class="bookitem">
 +
[[ContactsAPI|Contacts API (<i>restricted</i>)]]
 +
API for developers building contacts-related client applications.
 +
</div>
 +
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
====Channels API====
+
<!-- -------------- -->
−
* [[ChannelsAPI|Overview]]
+
<!-- START DOCUMENT -->
−
* [[QueryAgentState|Query Agent State]]
+
<div class="item">
−
* [[SetAgentStateAcrossAllChannels|Set Agent State Across All Channels]]
+
<div class="bookitem">
−
* [[SetAgentStateForAParticularChannel|Set Agent State For A Particular Channel]]
+
[[SettingsAPI|Settings API (<i>restricted</i>)]]
−
* [[CometDNotifications|CometD Notifications]]
+
Configuration tasks to modify the behavior of existing functionality.
 
</div>
 
</div>
 +
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
+
<!-- -------------- -->
−
====Provisioning API====
+
<!-- START DOCUMENT -->
−
*[[ProvisioningAPI|Overview]]
+
<div class="item">
−
*[[AgentStateOperations|AgentStateOperations]]
+
<div class="bookitem">
−
*[[DevicesAPI|Devices API]]
+
[[StatisticsAPI|Statistics API (<i>restricted</i>)]]
−
*[[Features|Features]]
+
API for developers building applications that use statistics.
−
*[[QueuesAPI|Queues API]]
+
</div>
−
*[[SkillsAPI|Skills API]]
 
−
*[[UsersAPI|Users API]]
 
 
</div>
 
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
+
<!-- -------------- -->
−
====Contacts API====
+
<!-- START DOCUMENT -->
−
*[[ContactsAPI|Overview]]
+
<div class="item">
−
*[[ContactsAttributes|Contacts Attributes]]
+
<div class="bookitem">
−
*[[ContactsOperations|Contacts operations]]
+
[[HierarchicalDispositionsAPI|Hierarchical Dispositions API (<i>restricted</i>)]]
−
*[[ContactsExamples|Examples]]
+
API for developers building dispositions-related client applications.
 +
</div>
 
</div>
 
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
+
<!-- -------------- -->
−
====Settings API====
+
<!-- START DOCUMENT -->
−
*[[SettingsAPI|Overview]]
+
<div class="item">
−
*[[SettingsAPIOperations|Operations]]
+
<div class="bookitem">
−
*[[SettingsAPIAttributes|Attributes]]
+
[[Examples|Examples (<i>restricted</i>)]]
−
*[[SettingsAPIExample|Example]]
+
Simple examples showing how to create applications to access the Genesys Web Services REST API.
−
*[[SettingsAPISupportedSettings|Supported Settings]]
 
−
*[[SettingsAPIUserDefinedSupportedSettings|User-Defined Supported Settings]]
 
 
</div>
 
</div>
 +
</div>
 +
<!-- FINISH DOCUMENT -->
 +
<!-- --------------- -->
  
−
<div class="map-box">
 
−
====Statistics API====
 
−
*[[StatisticsAPI|Overview]]
 
−
*[[ListOfStatisticsToBeMonitored|List of Statistics to be monitored]]
 
 
</div>
 
</div>
 +
<!--
 +
</div>
 +
-->
  
−
<div style="clear:both;"></div>
 
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 16:29, June 20, 2014

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 section might not be fully implemented in the application.


Overview

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

This Genesys Web Services REST API can be used to write agent applications that provide a variety of contact center-related features. These features include agent state management, call control, supervisor monitoring, and call recording.

This reference explains the resources and methods available to developers.

Each category presents information about relevant operations, related resources, request parameters, and return values.

General (restricted) Concepts employed by the various portions of the Genesys Web Services REST API.

Voice API (restricted) API for developers building voice-related client applications.

Multimedia Interactions API (restricted) API for developers building multimedia-related client applications.

Channels API (restricted) API for developers building applications that use channels.

Provisioning API (restricted) API for developers building applications that require provisioning.

Contacts API (restricted) API for developers building contacts-related client applications.

Settings API (restricted) Configuration tasks to modify the behavior of existing functionality.

Statistics API (restricted) API for developers building applications that use statistics.

Hierarchical Dispositions API (restricted) API for developers building dispositions-related client applications.

Examples (restricted) Simple examples showing how to create applications to access the Genesys Web Services REST API.

Comments or questions about this documentation? Contact us for support!