Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Update with the copy of version: 8.5.2DRAFT)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
 
=Web Services API Reference=
 
=Web Services API Reference=
−
__NOTOC__
+
__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.
−
 
 
−
{{RestrictHeader}}
 
−
 
 
−
==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.
 
−
 
 
−
<div class="itemcontainer">
 
−
<!-- -------------- -->
 
−
<!-- START DOCUMENT -->
 
−
<div class="item">
 
−
<div class="bookitem">
 
−
[[Examples|Samples (<i>restricted</i>)]]
 
−
Simple examples showing how to create applications to access the Genesys Web Services REST API.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
−
 
 
−
<!-- -------------- -->
 
−
<!-- START DOCUMENT -->
 
−
<div class="item">
 
−
<div class="bookitem">
 
−
[[General|General (<i>restricted</i>)]]
 
−
Concepts employed by the various portions of the Genesys Web Services REST API.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
The Web Services API offers the following services:
−
<!-- START DOCUMENT -->
 
−
<div class="item">
 
−
<div class="bookitem">
 
−
[[VoiceAPI|Voice API (<i>restricted</i>)]]
 
−
API for developers building voice-related client applications.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Voice API====
−
<div class="item">
+
[[VoiceAPI|Handle telephony interactions, including SIP.]]</div>
−
<div class="bookitem">
 
−
[[MultimediaAPI|Multimedia Interactions API (<i>restricted</i>)]]
 
−
API for developers building multimedia-related client applications.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Multimedia Interactions API====
−
<div class="item">
+
[[MultimediaAPI|Handle multimedia (eServices) interactions.]]</div>
−
<div class="bookitem">
 
−
[[ChannelsAPI|Channels API (<i>restricted</i>)]]
 
−
API for developers building applications that use channels.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Channels API====
−
<div class="item">
+
[[ChannelsAPI|Manage the different interaction channels available to an agent.]]</div>
−
<div class="bookitem">
 
−
[[ProvisioningAPI|Provisioning API (<i>restricted</i>)]]
 
−
API for developers building applications that require provisioning.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Provisioning API====
−
<div class="item">
+
[[ProvisioningAPI|Automate Genesys provisioning.]]</div>
−
<div class="bookitem">
 
−
[[DevicesAPI|Devices API (<i>restricted</i>)]]
 
−
API for developers building client applications and interacting with devices.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Contacts API====
−
<div class="item">
+
[[ContactsAPI|Manage contacts and interaction history.]]</div>
−
<div class="bookitem">
 
−
[[ContactsAPI|Contacts API (<i>restricted</i>)]]
 
−
API for developers to create or retrieve contacts.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Settings API====
−
<div class="item">
+
[[SettingsAPI|Configure Web Services parameters.]]</div>
−
<div class="bookitem">
 
−
[[SettingsAPI|Settings API (<i>restricted</i>)]]
 
−
Configuration tasks to modify the behavior of existing functionality.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Statistics API====
−
<div class="item">
+
[[StatisticsAPI|Make use of Genesys statistics.]]</div>
−
<div class="bookitem">
 
−
[[StatisticsAPI|Statistics API (<i>restricted</i>)]]
 
−
API for developers building applications that use statistics.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Hierarchical Dispositions API====
−
<div class="item">
+
[[HierarchicalDispositionsAPI|Manage the possible disposition values of interactions.]]</div>
−
<div class="bookitem">
 
−
[[HierarchicalDispositionsAPI|Hierarchical Dispositions API (<i>restricted</i>)]]
 
−
API for developers building dispositions-related client applications.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Platform Configuration API====
−
<div class="item">
+
[[InternalConfigAPI|Manage Configuration Server data.]]</div>
−
<div class="bookitem">
 
−
[[InternalConfigAPI|Platform Configuration API (<i>restricted</i>)]]
 
−
API for developers to get read and write access to low-level data from Configuration Server.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
 +
<div class="map-box">
 +
====Outbound API====
 +
[[OutboundAPI|Handle outbound interactions and campaigns.]]</div>
  
−
<!-- -------------- -->
+
<div class="map-box">
−
<!-- START DOCUMENT -->
+
====Interaction History API====
−
<div class="item">
+
[[InteractionHistory|Retrieve interaction history for an agent or contact.]]</div>
−
<div class="bookitem">
 
−
[[OutboundAPI|Outbound API (<i>restricted</i>)]]
 
−
API for developers to write client applications that include outbound preview features.
 
−
</div>
 
−
</div>
 
−
<!-- FINISH DOCUMENT -->
 
−
<!-- --------------- -->
 
  
−
</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!