Jump to: navigation, search

Add a Callback Service

Modified in 8.5.207

After Callback is configured, you must create a Callback Service for each Callback scenario that you want to implement. Then, you can manage Callback interactions in the Callback UI.

Load the Callback Service Template


Open the Service Management UI, and navigate to Services and Tools > Tools > Service Templates. By default, callback should be part of the Service Templates list.

If not, you must load the Callback service template before you can create a Callback service. The callback.zip template is located in the <GMS installation directory>/service_templates directory.

Once the callback template has been loaded, it is available in the filter drop-down list of the Services tab.

Create a Callback Service


Navigate to the Services and Tools > Services tab. There, you can manage your services based on the templates. The services and categories can be collapsed or expanded for easier viewing.

  1. Click Create.
  2. Enter a Service Name: This name will be used as the {callback-execution-name} parameter in your Callback queries.
  3. Select your Common Default Configuration. These configuration scenarios are detailed in the Callback Scenarios section of this guide.
  4. Click Add. An information message confirms the service creation. GMS-UI-PopUpMessage.png

The new Callback service appears in the Configured Services list.

The service is also created in the service.{callback-execution-name} section of your GMS configuration.

Configured Callback Services


Key parameters for the service are automatically populated with the appropriate default values. For cluster configurations, all changes made in a service will be replicated into the entire GMS cluster.

To configure your Callback service, refer to the configuration options described in the associated scenario page. See the Callback scenarios for further details.

The parameters have the following characteristics:

  • Mandatory parameters - are identified with a lock icon; you cannot rename them or remove them.
  • Optional parameters - you can rename them by hovering your cursor over the value field (you will see a pencil icon), click, and then enter the new value. You can delete optional parameters by clicking the Delete button.
  • Advanced parameters - can be displayed by selecting the Advanced button in the upper right.
  • Request parameters - are identified with an Request Parameter label in the Description.
Request parameters are usually provided within the request itself. Genesys recommends that you do not configure the Request parameters through this UI, otherwise, the parameter within the request will be overridden. If a value was entered through this UI and you wish to remove it at some later date, you can click the garbage can icon and the value becomes not specified.

Adding your Service to Virtual Service Groups

Introduced in 8.5.207

To add services to a given virtual group, add the _service_groups option to your service and enter a comma-separated list of group names.

For example, let's consider adding the 'support' service group by adding _service_groups = 'support' to the callback-support and callback-blackfriday-support services.

Then, you can use this virtual group to filter the services displayed to an agent. See Setting Permissions for further details.

Accessing Callback Services and Records with the Callback API

The URLs used by the Callback API are dependent on the name of the Callback service that you have just created. Callback services are available at the following URL:


For instance, if you create a callback service named callback-for-mobile, then {callback-execution-name} is callback-for-mobile and the callback service is available at:


For further details, see Callback API.

This page was last edited on December 21, 2018, at 15:14.
Comments or questions about this documentation? Contact us for support!