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
namespace Voice.Api.Dashboard

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CallCenterDashboardAgent() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val Queues:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val AgentState:String = null with get,set
        member val CallState:String = null with get,set
        member val SignInTime:String = null with get,set
        member val SignInDuration:String = null with get,set
        member val PercentAvailable:String = null with get,set
        member val AvgBusyIn:String = null with get,set
        member val AvgWrapUp:String = null with get,set
        member val DateOfLastCall:String = null with get,set

    [<AllowNullLiteral>]
    type CallCenterDashboardQueue() = 
        member val Name:String = null with get,set
        member val NumAgents:Int32 = new Int32() with get,set
        member val NumCallsQueued:Int32 = new Int32() with get,set
        member val LongestWaitingCall:String = null with get,set
        member val ExpectedWaitTime:String = null with get,set
        member val ExpectedHoldTime:String = null with get,set
        member val AverageSpeedOfAnswer:String = null with get,set
        member val IdleAgents:Int32 = new Int32() with get,set
        member val UnavailableAgents:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CallCenterDashboardCall() = 
        member val Id:String = null with get,set
        member val Customer:String = null with get,set
        member val Queue:String = null with get,set
        member val Agent:String = null with get,set
        member val State:String = null with get,set
        member val Duration:String = null with get,set
        member val Hold:String = null with get,set
        member val ExtraInfo:String = null with get,set

    [<AllowNullLiteral>]
    type CallCenterDashboard() = 
        member val Agents:ResizeArray<CallCenterDashboardAgent> = new ResizeArray<CallCenterDashboardAgent>() with get,set
        member val Queues:ResizeArray<CallCenterDashboardQueue> = new ResizeArray<CallCenterDashboardQueue>() with get,set
        member val Calls:ResizeArray<CallCenterDashboardCall> = new ResizeArray<CallCenterDashboardCall>() with get,set

    ///<summary>
    ///Returns the call center dashboard data
    ///</summary>
    [<Api(Description="Returns the call center dashboard data")>]
    [<AllowNullLiteral>]
    type GetCallCenterDashboard() = 
        interface IPost
        ///<summary>
        ///The account ID to retrieve for
        ///</summary>
        [<ApiMember(Description="The account ID to retrieve for")>]
        member val AccountId:String = null with get,set

F# GetCallCenterDashboard DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}