Jump to: navigation, search
(Update with the copy of version: draft)
(Automated save: adding PEC_Migrated template.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
= API Events =
 
= API Events =
−
Once you've registered your own plugin on the bus, you can subscribe and listen for published events. Below we'll quickly register a new plugin on the bus using the global bus object.
 
  
−
{{NoteFormat|The global bus object is a debug tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see [[GWCBusExtensions|Widgets Extensions]] for more information about extending Genesys Widgets.|1}}
+
{{Template:PEC_Migrated}}
  
  
−
<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
+
{{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/CallbackService-combined#API_Events.}}
−
 
 
−
oMyPlugin.subscribe('CallbackService.ready', function(e){});</source>
 
−
 
 
−
 
 
−
{|
 
−
|-
 
−
! Name
 
−
! Description
 
−
! Data
 
−
|-
 
−
| ready
 
−
| CallbackService is initialized and ready to accept commands.
 
−
| n/a
 
−
|-
 
−
| scheduled
 
−
| Callback is scheduled successfully.
 
−
| 200 OK AJAX Response - Schedule Callback
 
−
For Callback API v3, refer to 'Responses' in [https://developer.genhtcc.com/reference/callback/Callbacks/index.html#bookCallbackExternal Schedule Callback V3]
 
−
|-
 
−
| scheduleError
 
−
| An error occurred between the client and the server during a callback schedule.
 
−
| The JSON data returned by GMS Callback server.  
 
−
For Callback API v3, refer to 'Responses' in [https://developer.genhtcc.com/reference/callback/Callbacks/index.html#bookCallbackExternal Schedule Callback V3]
 
−
|-
 
−
| availableSlots
 
−
| Callback available slots fetched successfully.
 
−
| 200 OK AJAX Response - Query Callback Availability
 
−
For Callback API v3, refer to 'Responses' in [https://developer.genhtcc.com/reference/callback/Availability/index.html#queryAvailabilityV2 Availability Callback V3]
 
−
|-
 
−
| availabilityError
 
−
| An error occurred between the client and the server while fetching the available timeslots.
 
−
| The JSON data returned by GMS Callback server.
 
−
For Callback API v3, refer to 'Responses' in [https://developer.genhtcc.com/reference/callback/Availability/index.html#queryAvailabilityV2 Availability Callback V3]
 
−
|-
 
−
|}
 
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Latest revision as of 22:37, June 21, 2020

API Events

Important
This content may not be the latest Genesys Engage cloud content. To find the latest content, go to Genesys Engage cloud for Administrators.


Important
Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/CallbackService-combined#API_Events.
This page was last edited on June 21, 2020, at 22:37.
Comments or questions about this documentation? Contact us for support!