com.genesys.internal.engagement.api

Class EstimatedWaitTimeApi

java.lang.Object

com.genesys.internal.engagement.api.EstimatedWaitTimeApi

public class EstimatedWaitTimeApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
EstimatedWaitTimeApi()
EstimatedWaitTimeApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EstimatedWaitTimeResponse200	estimatedWaitTimeAPI1(java.lang.String xApiKey, java.lang.String virtualQueues, java.lang.String mode) Retrieves the estimated wait time for one or more virtual queues.
com.squareup.okhttp.Call	estimatedWaitTimeAPI1Async(java.lang.String xApiKey, java.lang.String virtualQueues, java.lang.String mode, ApiCallback<EstimatedWaitTimeResponse200> callback) Retrieves the estimated wait time for one or more virtual queues.
com.squareup.okhttp.Call	estimatedWaitTimeAPI1Call(java.lang.String xApiKey, java.lang.String virtualQueues, java.lang.String mode, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for estimatedWaitTimeAPI1
ApiResponse<EstimatedWaitTimeResponse200>	estimatedWaitTimeAPI1WithHttpInfo(java.lang.String xApiKey, java.lang.String virtualQueues, java.lang.String mode) Retrieves the estimated wait time for one or more virtual queues.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EstimatedWaitTimeApi

public EstimatedWaitTimeApi()

EstimatedWaitTimeApi

public EstimatedWaitTimeApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

estimatedWaitTimeAPI1Call

public com.squareup.okhttp.Call estimatedWaitTimeAPI1Call(java.lang.String xApiKey,
                                                          java.lang.String virtualQueues,
                                                          java.lang.String mode,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for estimatedWaitTimeAPI1

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

virtualQueues - One or more virtual queue names specified as a comma-delimited string. (required)

mode - EstimatedWaitTime calculation mode. You can set this value to mode1, mode2, or mode3. If not specified, the default value is mode2. If mode=mode1, the system checks how fast interactions go through the virtual queue and how many interactions are still pending. Note that mode1 only considers that last 32 interactions in the queue. The system ignores the current agent availability and does not immediately adjust the EstimatedWaitTime if, for example, all of the agents handling the queue suddenly logout. If mode=mode2, the system checks how fast interactions go through the virtual queue and how many interactions are pending. Additionally, the system takes into account the agents who have historically been handling interactions of the Virtual Queue. If there are no agents logged in, a value of -1 is returned. If mode=mode3, the statistics calculation from the Statistics Server, and not from the Routing Server, are used. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

estimatedWaitTimeAPI1

public EstimatedWaitTimeResponse200 estimatedWaitTimeAPI1(java.lang.String xApiKey,
                                                          java.lang.String virtualQueues,
                                                          java.lang.String mode)
                                                   throws ApiException

Retrieves the estimated wait time for one or more virtual queues. Retrieves the estimated wait time for one or more virtual queues.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

virtualQueues - One or more virtual queue names specified as a comma-delimited string. (required)

mode - EstimatedWaitTime calculation mode. You can set this value to mode1, mode2, or mode3. If not specified, the default value is mode2. If mode=mode1, the system checks how fast interactions go through the virtual queue and how many interactions are still pending. Note that mode1 only considers that last 32 interactions in the queue. The system ignores the current agent availability and does not immediately adjust the EstimatedWaitTime if, for example, all of the agents handling the queue suddenly logout. If mode=mode2, the system checks how fast interactions go through the virtual queue and how many interactions are pending. Additionally, the system takes into account the agents who have historically been handling interactions of the Virtual Queue. If there are no agents logged in, a value of -1 is returned. If mode=mode3, the statistics calculation from the Statistics Server, and not from the Routing Server, are used. (optional)

Returns:

EstimatedWaitTimeResponse200

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

estimatedWaitTimeAPI1WithHttpInfo

public ApiResponse<EstimatedWaitTimeResponse200> estimatedWaitTimeAPI1WithHttpInfo(java.lang.String xApiKey,
                                                                                   java.lang.String virtualQueues,
                                                                                   java.lang.String mode)
                                                                            throws ApiException

Retrieves the estimated wait time for one or more virtual queues. Retrieves the estimated wait time for one or more virtual queues.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

virtualQueues - One or more virtual queue names specified as a comma-delimited string. (required)

mode - EstimatedWaitTime calculation mode. You can set this value to mode1, mode2, or mode3. If not specified, the default value is mode2. If mode=mode1, the system checks how fast interactions go through the virtual queue and how many interactions are still pending. Note that mode1 only considers that last 32 interactions in the queue. The system ignores the current agent availability and does not immediately adjust the EstimatedWaitTime if, for example, all of the agents handling the queue suddenly logout. If mode=mode2, the system checks how fast interactions go through the virtual queue and how many interactions are pending. Additionally, the system takes into account the agents who have historically been handling interactions of the Virtual Queue. If there are no agents logged in, a value of -1 is returned. If mode=mode3, the statistics calculation from the Statistics Server, and not from the Routing Server, are used. (optional)

Returns:

ApiResponse<EstimatedWaitTimeResponse200>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

estimatedWaitTimeAPI1Async

public com.squareup.okhttp.Call estimatedWaitTimeAPI1Async(java.lang.String xApiKey,
                                                           java.lang.String virtualQueues,
                                                           java.lang.String mode,
                                                           ApiCallback<EstimatedWaitTimeResponse200> callback)
                                                    throws ApiException

Retrieves the estimated wait time for one or more virtual queues. (asynchronously) Retrieves the estimated wait time for one or more virtual queues.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

virtualQueues - One or more virtual queue names specified as a comma-delimited string. (required)

mode - EstimatedWaitTime calculation mode. You can set this value to mode1, mode2, or mode3. If not specified, the default value is mode2. If mode=mode1, the system checks how fast interactions go through the virtual queue and how many interactions are still pending. Note that mode1 only considers that last 32 interactions in the queue. The system ignores the current agent availability and does not immediately adjust the EstimatedWaitTime if, for example, all of the agents handling the queue suddenly logout. If mode=mode2, the system checks how fast interactions go through the virtual queue and how many interactions are pending. Additionally, the system takes into account the agents who have historically been handling interactions of the Virtual Queue. If there are no agents logged in, a value of -1 is returned. If mode=mode3, the statistics calculation from the Statistics Server, and not from the Routing Server, are used. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object