Jump to: navigation, search
(→‎Provisioning API)
(Update with the copy of version: 8.5.2DRAFT)
 
(33 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
=Web Services API Reference 8.5.2=
 
−
__NOTOC__
 
  
−
<span STYLE="color:red;">==RESTRICTED==</span>
+
=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 incorporate Genesys features into custom applications and integrations with third-party software.
  
−
<!-- Available styles: (default)-Important, 2-Tip, 3-Warning -->
+
The Web Services API offers the following services:
−
<!-- Important: equal signs (=) will not work in a note. Use the equivalent HTML code (&#61;) instead.-->
 
−
{{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.}}
 
  
 +
<div class="map-box">
 +
====Voice API====
 +
[[VoiceAPI|Handle telephony interactions, including SIP.]]</div>
  
−
Welcome to the ''Workspace Web Edition & Web Services API Reference''. The API Reference covers all the resources and methods available through the Web Services API Reference. Each subcategory presents information about relevant operations, related resources, Request parameters and Return values.  
+
<div class="map-box">
 +
====Multimedia Interactions API====
 +
[[MultimediaAPI|Handle multimedia (eServices) interactions.]]</div>
  
 +
<div class="map-box">
 +
====Channels API====
 +
[[ChannelsAPI|Manage the different interaction channels available to an agent.]]</div>
  
 
<div class="map-box">
 
<div class="map-box">
−
====General====
+
====Provisioning API====
−
*[[General|Overview]]
+
[[ProvisioningAPI|Automate Genesys provisioning.]]</div>
−
*[[RequestTypes|Request Parameters]]
 
−
*[[ReturnValues|Return Values]]
 
−
*[[Subresources|Subresources]]
 
−
*[[Filtering|Filtering]]
 
−
*[[Features|Features]]
 
−
*[[Services|Services]]
 
−
</div>
 
  
 
<div class="map-box">
 
<div class="map-box">
−
====Voice API====
+
====Contacts API====
−
*[[General|Overview]]
+
[[ContactsAPI|Manage contacts and interaction history.]]</div>
−
*[[Calls|Calls]]
 
−
*[[Call Forwarding|Call Forwarding]]
 
−
*[[ConferencesAndTransfers|Conferences and Transfers]]
 
−
*[[CallData|Attached Call Data]]
 
−
</div>
 
  
 
<div class="map-box">
 
<div class="map-box">
−
 
+
====Settings API====
−
====Voice API - Other====
+
[[SettingsAPI|Configure Web Services parameters.]]</div>
−
*[[Devices|Devices]]
 
−
*[[AgentState|Agent State]]
 
−
*[[Supervisor|Supervisor Activities]]
 
−
*[[CallRecording|Call Recording]]
 
−
*[[SessionManagement|Session Management]]
 
−
</div>
 
  
 
<div class="map-box">
 
<div class="map-box">
−
====Multimedia API====
+
====Statistics API====
−
*[[MultimediaAPI|Overview]]
+
[[StatisticsAPI|Make use of Genesys statistics.]]</div>
−
* [[Chat|Chat]]
 
−
* [[Email|Email]]
 
−
* [[Facebook|Facebook]]
 
−
* [[Twitter|Twitter]]
 
−
* [[Workbins|Workbins]]
 
−
</div>
 
  
 
<div class="map-box">
 
<div class="map-box">
−
 
+
====Hierarchical Dispositions API====
−
====Channels API====
+
[[HierarchicalDispositionsAPI|Manage the possible disposition values of interactions.]]</div>
−
* [[ChannelsAPI|Overview]]
 
−
* [[QueryAgentState|Query Agent State]]
 
−
* [[SetAgentStateAcrossAllChannels|Set Agent State Across All Channels]]
 
−
* [[SetAgentStateForAParticularChannel|Set Agent State For A Particular Channel]]
 
−
* [[CometDNotifications|CometD Notifications]]
 
−
</div>
 
  
 
<div class="map-box">
 
<div class="map-box">
−
 
+
====Platform Configuration API====
−
====Provisioning API====
+
[[InternalConfigAPI|Manage Configuration Server data.]]</div>
−
*[[ProvisioningAPI|Overview]]
 
−
*[[AgentStateOperations|AgentStateOperations]]
 
−
*[[DevicesAPI|Devices API]]
 
−
*[[Features|Features]]
 
−
*[[QueuesAPI|Queues API]]
 
−
*[[SkillsAPI|Skills API]]
 
−
*[[UsersAPI|Users API]]
 
−
</div>
 
  
 
<div class="map-box">
 
<div class="map-box">
−
 
+
====Outbound API====
−
====Contacts API====
+
[[OutboundAPI|Handle outbound interactions and campaigns.]]</div>
−
*[[ContactsAPI|Overview]]
 
−
*[[ContactsAttributes|Contacts Attributes]]
 
−
*[[ContactsOperations|Contacts operations]]
 
−
*[[ContactsExamples|Examples]]
 
−
</div>
 
  
 
<div class="map-box">
 
<div class="map-box">
−
 
+
====Interaction History API====
−
====Settings API====
+
[[InteractionHistory|Retrieve interaction history for an agent or contact.]]</div>
−
* [[SettingsAPI|Overview]]
 
−
</div>
 
  
 
<div class="map-box">
 
<div class="map-box">
 +
====Service API====
 +
[[ServiceAPI|Retrieve system runtime information.]]</div>
  
−
====Statistics API====
+
==Developer Support==
−
*[[StatisticsAPI|Overview]]
+
[https://developer.genesys.com/tag/wwe/ WWE on the Genesys Developer Portal].
−
*[[ListOfStatisticsToBeMonitored|List of Statistics to be monitored]]
 
−
</div>
 
−
 
 
−
<div style="clear:both;"></div>
 
  
 
[[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!