Revision as of 19:56, January 22, 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 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.

Getting Started Simple examples that show you how to quickly start using the API.

API Basics Details about general concepts used in the API.

Voice API API for developers building voice-related client applications.

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

Channels API API for developers building applications that use channels.

Provisioning API API for developers building applications that require provisioning.

Contacts API API for developers to create or retrieve contacts.

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

Statistics API API for developers building applications that use statistics.

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

Platform Configuration API API for developers to get read and write access to low-level data from Configuration Server.

Outbound API API for developers to write client applications that include outbound preview features.

Genesys Interaction Recording API API for developers to write client applications that play back recordings stored in the GIR system.

Genesys Interaction Recording Insertion API API for developers to write client applications that insert records into the GIR system.

@@ Line 1: / Line 1: @@
 =Web Services API Reference=
-__NOTOC__
+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.
-{{RestrictHeader}}
-==Overview==
+<div class="itemcontainer">
-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>)]]
+[[QuickStart|Getting Started]]
-Simple examples showing how to create applications to access the Genesys Web Services REST API.
+Simple examples that show you how to quickly start using the API.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[General|General (<i>restricted</i>)]]
+[[General|API Basics]]
-Concepts employed by the various portions of the Genesys Web Services REST API.
+Details about general concepts used in the API.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[VoiceAPI|Voice API (<i>restricted</i>)]]
+[[VoiceAPI|Voice API]]
 API for developers building voice-related client applications.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[MultimediaAPI|Multimedia Interactions API (<i>restricted</i>)]]
+[[MultimediaAPI|Multimedia Interactions API]]
 API for developers building multimedia-related client applications.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[ChannelsAPI|Channels API (<i>restricted</i>)]]
+[[ChannelsAPI|Channels API]]
 API for developers building applications that use channels.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[ProvisioningAPI|Provisioning API (<i>restricted</i>)]]
+[[ProvisioningAPI|Provisioning API]]
 API for developers building applications that require provisioning.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[ContactsAPI|Contacts API (<i>restricted</i>)]]
+[[ContactsAPI|Contacts API]]
 API for developers to create or retrieve contacts.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[SettingsAPI|Settings API (<i>restricted</i>)]]
+[[SettingsAPI|Settings API]]
 Configuration tasks to modify the behavior of existing functionality.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[StatisticsAPI|Statistics API (<i>restricted</i>)]]
+[[StatisticsAPI|Statistics API]]
 API for developers building applications that use statistics.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[HierarchicalDispositionsAPI|Hierarchical Dispositions API (<i>restricted</i>)]]
+[[HierarchicalDispositionsAPI|Hierarchical Dispositions API]]
 API for developers building dispositions-related client applications.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[InternalConfigAPI|Platform Configuration API (<i>restricted</i>)]]
+[[InternalConfigAPI|Platform Configuration API]]
 API for developers to get read and write access to low-level data from Configuration Server.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
-<!-- -------------- -->
-<!-- START DOCUMENT -->
 <div class="item">
 <div class="bookitem">
-[[OutboundAPI|Outbound API (<i>restricted</i>)]]
+[[OutboundAPI|Outbound API]]
 API for developers to write client applications that include outbound preview features.
 </div>
 </div>
-<!-- FINISH DOCUMENT -->
-<!-- --------------- -->
+<div class="item">
+<div class="bookitem">
+[[CallRecordingAPI|Genesys Interaction Recording API]]
+API for developers to write client applications that play back recordings stored in the GIR system.
+</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>
 <!--

Revision as of 19:56, January 22, 2016

Web Services API Reference

Contact

Genesys

Customer Care

Legal