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 java.io.InputStream
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")
    open var accountId:String? = null
}

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

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

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

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

Kotlin GetCallCenterDashboard DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: team.evovoice.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"agents":[{"id":"String","name":"String","queues":["String"],"agentState":"String","callState":"String","signInTime":"String","signInDuration":"String","percentAvailable":"String","avgBusyIn":"String","avgWrapUp":"String","dateOfLastCall":"String"}],"queues":[{"name":"String","numAgents":0,"numCallsQueued":0,"longestWaitingCall":"String","expectedWaitTime":"String","expectedHoldTime":"String","averageSpeedOfAnswer":"String","idleAgents":0,"unavailableAgents":0}],"calls":[{"id":"String","customer":"String","queue":"String","agent":"String","state":"String","duration":"String","hold":"String","extraInfo":"String"}]}