Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
 
=Web Services API Reference=
 
=Web Services API Reference=
−
Welcome to the ''Web Services API Reference''. This guide provides information about how you can use the Web Services REST API to write agent applications that provide contact center-related features, including agent state management, call control, supervisor monitoring, and call recording. Here you'll find details about the various APIs that make up the Web Services API, including operations, related resources, request parameters, and return values.  
+
__NOTOC__
 +
Welcome to the ''Web Services API Reference''. This guide provides information about how you can use the Web Services REST API to incorporate Genesys features into custom applications and integrations with third-party software.
  
 +
The Web Services API offers the following services:
  
−
<div class="itemcontainer">
+
<div class="map-box">
−
 
+
====Voice API====
−
<div class="item">
+
[[VoiceAPI|Handle telephony interactions, including SIP.]]
−
<div class="bookitem">
 
−
[[QuickStart|Getting Started]]
 
−
Simple examples that show you how to quickly start using the API.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Multimedia Interactions API====
−
[[General|API Basics]]
+
[[MultimediaAPI|Handle multimedia (eServices) interactions.]]
−
Details about general concepts used in the API.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Channels API====
−
[[VoiceAPI|Voice API]]
+
[[ChannelsAPI|Manage the different interaction channels available to an agent.]]
−
API for developers building voice-related client applications.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Provisioning API====
−
[[MultimediaAPI|Multimedia Interactions API]]
+
[[ProvisioningAPI|Automate Genesys provisioning.]]
−
API for developers building multimedia-related client applications.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Contacts API====
−
[[ChannelsAPI|Channels API]]
+
[[ContactsAPI|Manage contacts and interaction history.]]
−
API for developers building applications that use channels.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Settings API====
−
[[ProvisioningAPI|Provisioning API]]
+
[[SettingsAPI|Configure Web Services parameters.]]
−
API for developers building applications that require provisioning.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Statistics API====
−
[[ContactsAPI|Contacts API]]
+
[[StatisticsAPI|Make use of Genesys statistics.]]
−
API for developers to create or retrieve contacts.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Hierarchical Dispositions API====
−
[[SettingsAPI|Settings API]]
+
[[HierarchicalDispositionsAPI|Manage the possible disposition values of interactions.]]
−
Configuration tasks to modify the behavior of existing functionality.  
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Platform Configuration API====
−
[[StatisticsAPI|Statistics API]]
+
[[InternalConfigAPI|Manage Configuration Server data.]]
−
API for developers building applications that use statistics.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Outbound API====
−
[[HierarchicalDispositionsAPI|Hierarchical Dispositions API]]
+
[[OutboundAPI|Handle outbound interactions and campaigns.]]
−
API for developers building dispositions-related client applications.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Genesys Interaction Recording API====
−
[[InternalConfigAPI|Platform Configuration API]]
+
[[CallRecordingAPI|Retrieve recordings from Genesys Interaction Recording.]]
−
API for developers to get read and write access to low-level data from Configuration Server.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Genesys Interaction Recording Insertion API====
−
[[OutboundAPI|Outbound API]]
+
[[CRInsertionAPI|Insert recordings into Genesys Interaction Recording.]]
−
API for developers to write client applications that include outbound preview features.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Interaction History API====
−
[[CallRecordingAPI|Genesys Interaction Recording API]]
+
[[InteractionHistory|Retrieve interaction history for an agent or contact.]]
−
API for developers to write client applications that play back recordings stored in the GIR system.
 
−
</div>
 
 
</div>
 
</div>
  
−
<div class="item">
 
−
<div class="bookitem">
 
−
[[CRInsertionAPI|Genesys Interaction Recording Insertion API]]
 
−
API for developers to write client applications that insert records into the GIR system.
 
−
</div>
 
−
</div>
 
  
−
</div>
+
<div style="clear:both;"></div>
−
<!--
 
−
</div>
 
−
-->
 
  
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 18:22, March 25, 2016

Web Services API Reference

Welcome to the Web Services API Reference. This guide provides information about how you can use the Web Services REST API to incorporate Genesys features into custom applications and integrations with third-party software.

The Web Services API offers the following services:

Voice API

Handle telephony interactions, including SIP.

Multimedia Interactions API

Handle multimedia (eServices) interactions.

Channels API

Manage the different interaction channels available to an agent.

Provisioning API

Automate Genesys provisioning.

Contacts API

Manage contacts and interaction history.

Settings API

Configure Web Services parameters.

Statistics API

Make use of Genesys statistics.

Hierarchical Dispositions API

Manage the possible disposition values of interactions.

Platform Configuration API

Manage Configuration Server data.

Outbound API

Handle outbound interactions and campaigns.

Genesys Interaction Recording API

Retrieve recordings from Genesys Interaction Recording.

Genesys Interaction Recording Insertion API

Insert recordings into Genesys Interaction Recording.

Interaction History API

Retrieve interaction history for an agent or contact.


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