Jump to: navigation, search

Capacity API

The Capacity Service enables you to define the number of scheduled callbacks that are allowed for Callback for a given time slot in the week. Then, your Callback service refers to your Capacity service and to your Office Hours service to adjust the agent availability and the number of scheduled callbacks.

You can define exceptions for dates where less or more agents are available, and you can define as many Capacity services that you need to match your Callback services. This way, you can address the agent workload according to the real resources that are available.


Here is an example of GMS configuration:

_capacity=[Mon, Tue, Wed, Thu, Fri, Sat, Sun]
You can also configure a capacity service in the Service Management UI.


When you add a capacity service through the Configured Services interface, you can access the capacity service by its execution name and retrieve content through the API.

In order to find the available capacity, the query provides a date and time range. The response object provides a list of time periods and available capacity for each period. Here is a list of input parameters:

GET /genesys/1/service/{capacity-execution-name}?start=<date and time>&end=<date and time>&timezone=<timezone>
Name Description Required
start yes Start date and time in ISO-8601 format without a timezone component; for example: 2015-03-17T09:15:00.000
end yes End date and time in ISO-8601 format without a timezone component; for example: 2015-03-17T12:45:00.000
timezone yes Timezone used for "start" and "end" parameters; for example: America/Los_Angeles

For example, the following request will provide the following results:

GET /genesys/1/service/Capacity?start=2016-10-05T15:00:00.000Z&number-of-days=2 HTTP/1.1
> Host:
> User-Agent: curl/7.50.3
> Accept: */*
< HTTP/1.1 200 OK
< Set-Cookie: JSESSIONID=1opza084c3vszo631xnrtqw38;Path=/genesys;HttpOnly
< Expires: Thu, 01 Jan 1970 00:00:00 GMT
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
  "error": null,
  "slots": [
      "utcTime": "2016-10-05T15:00:00.000Z",
      "localTime": "2016-10-05T15:00:00.000Z",
      "durationMin": 540,
      "capacity": 6
      "utcTime": "2016-10-06T01:00:00.000Z",
      "localTime": "2016-10-06T01:00:00.000Z",
      "durationMin": 60,
      "capacity": 3
      "utcTime": "2016-10-06T11:00:00.000Z",
      "localTime": "2016-10-06T11:00:00.000Z",
      "durationMin": 60,
      "capacity": 3
  "timezone": "UTC"

Comment on this article:

blog comments powered by Disqus
This page was last modified on 4 January 2018, at 02:55.