Queue—Get List of Queues for User

This API allows a user to get a list of all queues associated with that user.


Note


The list of queues does not include the system-defined queue (skill group) present in Unified CCE to which all agents belong.


URI:

http://<FQDN>/finesse/api/User/<id>/Queues

Example URI:

http://finesse1.xyz.com/finesse/api/User/1234/Queues

Security Constraints:

All users can use this API to retrieve a list of queues for any user.

HTTP Method:

GET

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

HTTP Response:

200: Success

401: Authorization Failure

404: User Not Found

500: Internal Server Error

Example Response:

<Queues>
  <Queue>
    <uri>/finesse/api/Queue/1234</uri>
    <name>Sales</name>
    <statistics>
      <callsInQueue>3</callsInQueue>
      <startTimeOfLongestCallInQueue>2012-02-15T17:58:21Z
       </startTimeOfLongestCallInQueue>
       <agentsReady>1</agentsReady>
       <agentsNotReady>2</agentsNotReady>
       <agentsTalkingInbound>3</agentsTalkingInbound>
       <agentsTalkingOutbound>4</agentsTalkingOutbound>
       <agentsTalkingInternal>5</agentsTalkingInternal>
       <agentsWrapUpNotReady>6</agentsWrapUpNotReady>  
       <agentsWrapUpReady>7</agentsWrapUpReady>
    </statistics>
 </Queue>
  ... more queues ...
</Queues>

Example Failure Response:

<ApiErrors>
     <ApiError>
          <ErrorType>Authorization Failure</ErrorType>
          <ErrorMessage>UNAUTHORIZED</ErrorMessage>
          <ErrorData>jsmith</ErrorData>
   </ApiError>
</ApiErrors>

Platform-Based API Differences

The following statistics fields are updated only for a stand-alone Finesse deployment with Unified CCE:

In a coresident Finesse deployment with Unified CCX, these fields are not updated and the value for each field is -1.