Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Update with the copy of version: 8.5.2DRAFT)
 
(5 intermediate revisions by 4 users not shown)
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.
−
 
 
−
 
 
−
<div class="itemcontainer">
 
−
 
 
−
<div class="item">
 
−
<div class="bookitem">
 
−
[[QuickStart|Getting Started]]
 
−
Simple examples that show you how to quickly start using the API.
 
−
</div>
 
−
</div>
 
−
 
 
−
<div class="item">
 
−
<div class="bookitem">
 
−
[[General|API Basics]]
 
−
Details about general concepts used in the API.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
The Web Services API offers the following services:
−
<div class="bookitem">
 
−
[[VoiceAPI|Voice API]]
 
−
API for developers building voice-related client applications.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Voice API====
−
[[MultimediaAPI|Multimedia Interactions API]]
+
[[VoiceAPI|Handle telephony interactions, including SIP.]]</div>
−
API for developers building multimedia-related client applications.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Multimedia Interactions API====
−
[[ChannelsAPI|Channels API]]
+
[[MultimediaAPI|Handle multimedia (eServices) interactions.]]</div>
−
API for developers building applications that use channels.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Channels API====
−
[[ProvisioningAPI|Provisioning API]]
+
[[ChannelsAPI|Manage the different interaction channels available to an agent.]]</div>
−
API for developers building applications that require provisioning.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Provisioning API====
−
[[ContactsAPI|Contacts API]]
+
[[ProvisioningAPI|Automate Genesys provisioning.]]</div>
−
API for developers to create or retrieve contacts.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Contacts API====
−
[[SettingsAPI|Settings API]]
+
[[ContactsAPI|Manage contacts and interaction history.]]</div>
−
Configuration tasks to modify the behavior of existing functionality.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Settings API====
−
[[StatisticsAPI|Statistics API]]
+
[[SettingsAPI|Configure Web Services parameters.]]</div>
−
API for developers building applications that use statistics.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Statistics API====
−
[[HierarchicalDispositionsAPI|Hierarchical Dispositions API]]
+
[[StatisticsAPI|Make use of Genesys statistics.]]</div>
−
API for developers building dispositions-related client applications.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Hierarchical Dispositions API====
−
[[InternalConfigAPI|Platform Configuration API]]
+
[[HierarchicalDispositionsAPI|Manage the possible disposition values of interactions.]]</div>
−
API for developers to get read and write access to low-level data from Configuration Server.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Platform Configuration API====
−
[[OutboundAPI|Outbound API]]
+
[[InternalConfigAPI|Manage Configuration Server data.]]</div>
−
API for developers to write client applications that include outbound preview features.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Outbound API====
−
[[CallRecordingAPI|Genesys Interaction Recording API]]
+
[[OutboundAPI|Handle outbound interactions and campaigns.]]</div>
−
API for developers to write client applications that play back recordings stored in the GIR system.
 
−
</div>
 
−
</div>
 
  
−
<div class="item">
+
<div class="map-box">
−
<div class="bookitem">
+
====Interaction History API====
−
[[CRInsertionAPI|Genesys Interaction Recording Insertion API]]
+
[[InteractionHistory|Retrieve interaction history for an agent or contact.]]</div>
−
API for developers to write client applications that insert records into the GIR system.
 
−
</div>
 
−
</div>
 
  
−
</div>
+
<div class="map-box">
−
<!--
+
====Service API====
−
</div>
+
[[ServiceAPI|Retrieve system runtime information.]]</div>
−
-->
 
  
 +
==Developer Support==
 +
[https://developer.genesys.com/tag/wwe/ WWE on the Genesys Developer Portal].
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Latest revision as of 20:55, July 19, 2021

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.

Interaction History API

Retrieve interaction history for an agent or contact.

Service API

Retrieve system runtime information.

Developer Support

WWE on the Genesys Developer Portal.

This page was last edited on July 19, 2021, at 20:55.
Comments or questions about this documentation? Contact us for support!