Evo Voice

<back to all web services

GetCallCenterDashboard

Returns the call center dashboard data

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager
The following routes are available for this service:
GET/dashboard/call-center
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Returns the call center dashboard data
*/
@Api(Description="Returns the call center dashboard data")
open class GetCallCenterDashboard : IPost
{
    /**
    * The account ID to retrieve for
    */
    @ApiMember(Description="The account ID to retrieve for")
    var accountId:String? = null
}

open class CallCenterDashboard
{
    var agents:ArrayList<CallCenterDashboardAgent> = ArrayList<CallCenterDashboardAgent>()
    var queues:ArrayList<CallCenterDashboardQueue> = ArrayList<CallCenterDashboardQueue>()
    var calls:ArrayList<CallCenterDashboardCall> = ArrayList<CallCenterDashboardCall>()
}

open class CallCenterDashboardAgent
{
    var id:String? = null
    var name:String? = null
    var queues:ArrayList<String> = ArrayList<String>()
    var agentState:String? = null
    var callState:String? = null
    var signInTime:String? = null
    var signInDuration:String? = null
    var percentAvailable:String? = null
    var avgBusyIn:String? = null
    var avgWrapUp:String? = null
    var dateOfLastCall:String? = null
}

open class CallCenterDashboardQueue
{
    var name:String? = null
    var numAgents:Int? = null
    var numCallsQueued:Int? = null
    var longestWaitingCall:String? = null
    var expectedWaitTime:String? = null
    var expectedHoldTime:String? = null
    var averageSpeedOfAnswer:String? = null
    var idleAgents:Int? = null
    var unavailableAgents:Int? = null
}

open class CallCenterDashboardCall
{
    var id:String? = null
    var customer:String? = null
    var queue:String? = null
    var agent:String? = null
    var state:String? = null
    var duration:String? = null
    var hold:String? = null
    var extraInfo:String? = null
}

Kotlin GetCallCenterDashboard DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /dashboard/call-center HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CallCenterDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Dashboard">
  <Agents>
    <CallCenterDashboardAgent>
      <AgentState>String</AgentState>
      <AvgBusyIn>String</AvgBusyIn>
      <AvgWrapUp>String</AvgWrapUp>
      <CallState>String</CallState>
      <DateOfLastCall>String</DateOfLastCall>
      <Id>String</Id>
      <Name>String</Name>
      <PercentAvailable>String</PercentAvailable>
      <Queues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Queues>
      <SignInDuration>String</SignInDuration>
      <SignInTime>String</SignInTime>
    </CallCenterDashboardAgent>
  </Agents>
  <Calls>
    <CallCenterDashboardCall>
      <Agent>String</Agent>
      <Customer>String</Customer>
      <Duration>String</Duration>
      <ExtraInfo>String</ExtraInfo>
      <Hold>String</Hold>
      <Id>String</Id>
      <Queue>String</Queue>
      <State>String</State>
    </CallCenterDashboardCall>
  </Calls>
  <Queues>
    <CallCenterDashboardQueue>
      <AverageSpeedOfAnswer>String</AverageSpeedOfAnswer>
      <ExpectedHoldTime>String</ExpectedHoldTime>
      <ExpectedWaitTime>String</ExpectedWaitTime>
      <IdleAgents>0</IdleAgents>
      <LongestWaitingCall>String</LongestWaitingCall>
      <Name>String</Name>
      <NumAgents>0</NumAgents>
      <NumCallsQueued>0</NumCallsQueued>
      <UnavailableAgents>0</UnavailableAgents>
    </CallCenterDashboardQueue>
  </Queues>
</CallCenterDashboard>