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:

Developer Support

WWE on the Genesys Developer Portal.

@@ 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">
-====General====
+====Channels API====
-*[[General|Overview]]
+[[ChannelsAPI|Manage the different interaction channels available to an agent.]]</div>
-*[[RequestTypes|Request Parameters]]
-*[[ReturnValues|Return Values]]
-*[[Subresources|Subresources]]
-*[[Filtering|Filtering]]
-*[[Features|Features]]
-*[[Services|Services]]
-</div>
 <div class="map-box">
-====Voice API====
+====Provisioning API====
-*[[VoiceAPI|Overview]]
+[[ProvisioningAPI|Automate Genesys provisioning.]]</div>
-*[[Calls|Calls]]
-*[[Call Forwarding|Call Forwarding]]
-*[[ConferencesAndTransfers|Conferences and Transfers]]
-*[[CallData|Attached Call Data]]
-</div>
 <div class="map-box">
-====Voice API - Other====
+====Contacts API====
-*[[AgentState|Agent State]]
+[[ContactsAPI|Manage contacts and interaction history.]]</div>
-*[[Supervisor|Supervisor Activities]]
-*[[CallRecording|Call Recording]]
-*[[SessionManagement|Session Management]]
-</div>
 <div class="map-box">
-====eServices API====
+====Settings API====
-*[[MultimediaAPI|Overview]]
+[[SettingsAPI|Configure Web Services parameters.]]</div>
-* [[Chat|Chat]]
-* [[Email|Email]]
-* [[Facebook|Facebook]]
-* [[Twitter|Twitter]]
-* [[Workbins|Workbins]]
-</div>
 <div class="map-box">
+====Statistics API====
+[[StatisticsAPI|Make use of Genesys statistics.]]</div>
-====Channels API====
+<div class="map-box">
-* [[ChannelsAPI|Overview]]
+====Hierarchical Dispositions API====
-* [[QueryAgentState|Query Agent State]]
+[[HierarchicalDispositionsAPI|Manage the possible disposition values of interactions.]]</div>
-* [[SetAgentStateAcrossAllChannels|Set Agent State Across All Channels]]
-* [[SetAgentStateForAParticularChannel|Set Agent State For A Particular Channel]]
-* [[CometDNotifications|CometD Notifications]]
-</div>
 <div class="map-box">
-====Provisioning API====
+====Platform Configuration API====
-*[[ProvisioningAPI|Overview]]
+[[InternalConfigAPI|Manage Configuration Server data.]]</div>
-*[[AgentStateOperations|AgentStateOperations]]
-*[[DevicesAPI|Devices API]]
-*[[Features|Features]]
-*[[QueuesAPI|Queues API]]
-*[[SkillsAPI|Skills API]]
-*[[UsersAPI|Users API]]
-</div>
 <div class="map-box">
-====Contacts API====
+====Outbound API====
-*[[ContactsAPI|Overview]]
+[[OutboundAPI|Handle outbound interactions and campaigns.]]</div>
-*[[ContactsAttributes|Contacts Attributes]]
-*[[ContactsOperations|Contacts operations]]
-*[[ContactsExamples|Examples]]
-</div>
 <div class="map-box">
-====Settings API====
+====Interaction History API====
-*[[SettingsAPI|Overview]]
+[[InteractionHistory|Retrieve interaction history for an agent or contact.]]</div>
-*[[SettingsAPIOperations|Operations]]
-*[[SettingsAPIAttributes|Attributes]]
-*[[SettingsAPIExample|Example]]
-*[[SettingsAPISupportedSettings|Supported Settings]]
-*[[SettingsAPIUserDefinedSupportedSettings|User-Defined Supported Settings]]
-</div>
 <div class="map-box">
-====Statistics API====
+====Service API====
-*[[StatisticsAPI|Overview]]
+[[ServiceAPI|Retrieve system runtime information.]]</div>
-*[[ListOfStatisticsToBeMonitored|List of Statistics to be monitored]]
-</div>
-<div style="clear:both;"></div>
+==Developer Support==
+[https://developer.genesys.com/tag/wwe/ WWE on the Genesys Developer Portal].
 [[Category:V:HTCC:8.5.2]]

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

Web Services API Reference

Voice API

Multimedia Interactions API

Channels API

Provisioning API

Contacts API

Settings API

Statistics API

Hierarchical Dispositions API

Platform Configuration API

Outbound API

Interaction History API

Service API

Developer Support

Contact

Genesys

Customer Care

Legal