WID/Current/SDK/CallbackService-combined - Revision history

Chrissyforrest: Published

2020-10-22T23:20:44Z

Published

Chrissyforrest: Published

2020-07-30T21:17:12Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:38:09Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:50:43Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Chrissyforrest: Published

2020-07-07T18:28:19Z

Published

Chrissyforrest: Published

2020-06-02T14:06:14Z

Published

Chrissyforrest: Published

2020-05-11T22:05:21Z

Published

Chrissyforrest: Published

2020-05-01T13:40:57Z

Published

Chrissyforrest: Published

2020-04-27T14:35:32Z

Published

Show changes

Chrissyforrest: Published

2020-04-09T21:52:05Z

Published

@@ Line 10: / Line 10: @@
 |sectionHeading=Overview
 |alignment=Vertical
-|structuredtext=CallbackService exposes high-level API access to Genesys callback services, allowing you to use our {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=Callback-combined}} Widget to schedule a callback with customer service—or to develop your own custom Callback Widget. CallbackService dramatically simplifies integration, improving the reliability, feature set, and compatibility of every widget on the bus.
+|structuredtext=CallbackService exposes high-level API access to Genesys Callback services, allowing you to use our {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=Callback-combined}} Widget to schedule a callback with customer service—or to develop your own custom Callback Widget. CallbackService dramatically simplifies integration, improving the reliability, feature set, and compatibility of every widget on the bus.
 ===Usage===
-CallbackService and the matching Callback widget work together right out of the box and they share the same configuration object. Using Callback uses CallbackService.
+Callback Service and the matching Callback widget work together, and they share a configuration object. Using Callback uses CallbackService.
-You can also use CallbackService as a high-level API using bus commands and events to build your own Callback widget.
+You can also use Callback Service as a high-level API using bus commands and events to build your own Callback widget.
 ===Namespace===
 The CallbackService plugin has the following namespaces tied to each of the following types:
@@ Line 23: / Line 23: @@
 {{!}}-
 {{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=CallbackService-combined|anchor=config|display text=Configuration}}
-{{!}}{{!}}sendmessage
+{{!}}{{!}}Sendmessage
 {{!}}-
 {{!}}{{!}}CXBus—{{Link-SomewhereInThisVersion|manual=SDK|topic=CallbackService-combined|anchor=commands|display text=API commands}} & {{Link-SomewhereInThisVersion|manual=SDK|topic=CallbackService-combined|anchor=events|display text=API events}}
@@ Line 31: / Line 31: @@
 ===Customization===
-CallbackService does not have customization options. It is a plug-and-play plugin and works as is.
+CallbackService does not have customization options. It is a Plug and Play plugin and works as is.
 |Status=No
 }}{{Section
@@ Line 124: / Line 124: @@
 |structuredtext=Once you've registered your plugin on the bus, you can call commands on other registered plugins. Here's how to use the global bus object to register a new plugin on the bus.
-{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
+{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
 <source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
@@ Line 333: / Line 333: @@
 |structuredtext=Once you've registered your plugin on the bus, you can subscribe to and listen for published events. Here's how to use the global bus object to register a new plugin on the bus.
-{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
+{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
 <source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

@@ Line 3: / Line 3: @@
 |DisplayName=CallbackService
 |TocName=CallbackService
-|Context=Learn how to schedule a callback with customer service.
+|Context=Learn how to use CallbackService to schedule a callback with customer service.
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
-|Prereq=
+|Role=Developer
 |Section={{Section
 |sectionHeading=Overview
 |alignment=Vertical
 |structuredtext=CallbackService exposes high-level API access to Genesys callback services, allowing you to use our {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=Callback-combined}} Widget to schedule a callback with customer service—or to develop your own custom Callback Widget. CallbackService dramatically simplifies integration, improving the reliability, feature set, and compatibility of every widget on the bus.
 ===Usage===
@@ Line 19: / Line 16: @@
 You can also use CallbackService as a high-level API using bus commands and events to build your own Callback widget.
 ===Namespace===
-The Callback Service plugin has the following namespaces tied up with each of the following types:
+The CallbackService plugin has the following namespaces tied to each of the following types:
 {{{!}} class="wikitable" style="width: auto;"
 {{!}}-
@@ Line 35: / Line 32: @@
 ===Customization===
 CallbackService does not have customization options. It is a plug-and-play plugin and works as is.
 |Status=No
 }}{{Section
@@ Line 42: / Line 37: @@
 |anchor=config
 |alignment=Vertical
 |structuredtext====Description===
 Callback and CallbackService share the '''_genesys.widgets.callback''' configuration namespace. Callback contains the UI options and CallbackService contains the connection options.
@@ Line 118: / Line 111: @@
 {{!}}{{!}}
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 125: / Line 116: @@
 |anchor=localize
 |alignment=Vertical
 |structuredtext=CallbackService does not have localization options.
 |Status=No
 }}{{Section
@@ Line 135: / Line 122: @@
 |anchor=commands
 |alignment=Vertical
 |structuredtext=Once you've registered your plugin on the bus, you can call commands on other registered plugins. Here's how to use the global bus object to register a new plugin on the bus.
@@ Line 341: / Line 326: @@
 {{!}}{{!}}'No query parameters passed for callback availability service'
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 348: / Line 331: @@
 |anchor=events
 |alignment=Vertical
 |structuredtext=Once you've registered your plugin on the bus, you can subscribe to and listen for published events. Here's how to use the global bus object to register a new plugin on the bus.
@@ Line 387: / Line 368: @@
   For Callback API v3, refer to 'Responses' in [https://developer.genesyscloud.com/reference/engagement/Availability/index.html#queryAvailabilityV2 Availability Callback V3]
 {{!}}}
 |Status=No
 }}
 }}

@@ Line 5: / Line 5: @@
 |Context=Learn how to schedule a callback with customer service.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section

@@ Line 5: / Line 5: @@
 |Context=Learn how to schedule a callback with customer service.
 |ComingSoon=No
-|Platform=PureEngage
+|Platform=GenesysEngage-onpremises
 |Prereq=
 |Section={{Section

@@ Line 99: / Line 99: @@
 {{!}}{{!}}serviceName
 {{!}}{{!}}string
-{{!}}{{!}}Service Name of Callback API in v3.
+{{!}}{{!}}Name of the Callback virtual queue.
 {{!}}{{!}}n/a
 {{!}}{{!}}n/a

@@ Line 4: / Line 4: @@
 |TocName=CallbackService
 |Context=Learn how to schedule a callback with customer service.
 |ComingSoon=No
 |Platform=PureEngage
 |Prereq=
 |Section={{Section
@@ Line 84: / Line 80: @@
 {{!}}{{!}}dataURL
 {{!}}{{!}}URL String
-{{!}}{{!}}URL to the API endpoint for Callback.
+{{!}}{{!}}URL to the API endpoint for Callback.{{NoteFormat|The base URL for your API endpoints is:
-<nowiki>https://gapi-</nowiki><region>.genesyscloud.com/engagement/v3
+<nowiki>https://gapi-<region>.genesyscloud.com/engagement/v3</nowiki>
-You will receive the <code><region></code> information from Genesys at the same time that you receive your API key.
+You will receive the <region> information from Genesys at the same time that you receive your API key.|}}
 {{!}}{{!}}n/a
 {{!}}{{!}}n/a
@@ Line 96: / Line 91: @@
 {{!}}{{!}}apiVersion
 {{!}}{{!}}string
-{{!}}{{!}}Version of Callback API.
+{{!}}{{!}}Version of Callback API.{{NoteFormat|This value determines the version of Callback API.|}}
 {{!}}{{!}}'v3'
@@ Line 214: / Line 207: @@
 {{!}}{{!}}userData
 {{!}}{{!}}object
-{{!}}{{!}}Arbitrary data that is to be attached with callback schedule. Properties defined here will be merged with default userData set in the configuration object. If Genesys Web Engagement (GWE) is enabled, this userData also includes visitID, globalVisitID and pageID.
+{{!}}{{!}}Arbitrary data that is to be attached with callback schedule. Properties defined here will be merged with default userData set in the configuration object.
 {{!}}-
 {{!}}{{!}}serviceName
@@ Line 231: / Line 224: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When server confirms callback is scheduled
+{{!}}{{!}}Server confirms callback is scheduled
 {{!}}{{!}}200 OK AJAX Response - Schedule Callback
@@ Line 237: / Line 230: @@
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When selected timeslot is not available
+{{!}}{{!}}Selected time slot is not available
 {{!}}{{!}}400 Bad Request AJAX Error Response
@@ Line 243: / Line 236: @@
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When AJAX exception occurs
+{{!}}{{!}}AJAX exception occurs
 {{!}}{{!}}429 Too Many Requests AJAX Error Response
@@ Line 249: / Line 242: @@
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When server exception occurs
+{{!}}{{!}}Server exception occurs
 {{!}}{{!}}500 Internal Server Error Response
@@ Line 255: / Line 248: @@
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When no form data is found to schedule callback
+{{!}}{{!}}No form data is found to schedule callback
 {{!}}{{!}}'No data found to schedule callback'
 {{!}}}
@@ Line 321: / Line 314: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When server confirms the list of available callback timeslots
+{{!}}{{!}}Server confirms the list of available callback time slots
 {{!}}{{!}}200 OK AJAX Response - Query Callback Availability
@@ Line 327: / Line 320: @@
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When timeslots are not available for selected period
+{{!}}{{!}}Time slots are not available for selected period
 {{!}}{{!}}400 Bad Request AJAX Response
@@ Line 333: / Line 326: @@
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When AJAX exception occurs
+{{!}}{{!}}AJAX exception occurs
 {{!}}{{!}}400 Bad Request AJAX Response
@@ Line 339: / Line 332: @@
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When server exception occurs
+{{!}}{{!}}Server exception occurs
 {{!}}{{!}}500 Internal Server Error Response
@@ Line 345: / Line 338: @@
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When no query data is found
+{{!}}{{!}}No query data is found
 {{!}}{{!}}'No query parameters passed for callback availability service'
 {{!}}}

@@ Line 377: / Line 377: @@
 {{!}}{{!}}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]
+  For Callback API v3, refer to 'Responses' in [https://developer.genesyscloud.com/reference/engagement/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 Callback server.
-  For Callback API v3, refer to 'Responses' in [https://developer.genhtcc.com/reference/callback/Callbacks/index.html#bookCallbackExternal Schedule Callback V3]
+  For Callback API v3, refer to 'Responses' in [https://developer.genesyscloud.com/reference/engagement/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]
+  For Callback API v3, refer to 'Responses' in [https://developer.genesyscloud.com/reference/engagement/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 Callback server.
-  For Callback API v3, refer to 'Responses' in [https://developer.genhtcc.com/reference/callback/Availability/index.html#queryAvailabilityV2 Availability Callback V3]
+  For Callback API v3, refer to 'Responses' in [https://developer.genesyscloud.com/reference/engagement/Availability/index.html#queryAvailabilityV2 Availability Callback V3]
 {{!}}}
 |structuredtextwide=

@@ Line 163: / Line 163: @@
 Internal use only. The main App plugin shares configuration settings with widgets using each widget’s configure command. The configure command can only be called at startup. Calling configure again after startup may result in unpredictable behavior.
 ===schedule===
-Schedule a callback service with the GMS callback schedule API.
+Schedule a callback service with the callback schedule API.
 ====Example====
 <source lang="javascript">
@@ Line 261: / Line 261: @@
 ===availability===
-Get the list of available callback time slots using the GMS callback service.
+Get the list of available callback time slots using the callback service.
 ====Example====
 <source lang="javascript">
@@ Line 381: / Line 381: @@
 {{!}}{{!}}scheduleError
 {{!}}{{!}}An error occurred between the client and the server during a callback schedule.
-{{!}}{{!}}The JSON data returned by GMS Callback server.
+{{!}}{{!}}The JSON data returned by Callback server.
   For Callback API v3, refer to 'Responses' in [https://developer.genhtcc.com/reference/callback/Callbacks/index.html#bookCallbackExternal Schedule Callback V3]
 {{!}}-
@@ Line 391: / Line 391: @@
 {{!}}{{!}}availabilityError
 {{!}}{{!}}An error occurred between the client and the server while fetching the available timeslots.
-{{!}}{{!}}The JSON data returned by GMS Callback server.
+{{!}}{{!}}The JSON data returned by Callback server.
   For Callback API v3, refer to 'Responses' in [https://developer.genhtcc.com/reference/callback/Availability/index.html#queryAvailabilityV2 Availability Callback V3]
 {{!}}}

WID/Current/SDK/CallbackService-combined - Revision history

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"