Evo Voice

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 .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>