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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Dashboard;

namespace Voice.Api.Dashboard
{
    public partial class CallCenterDashboard
    {
        public CallCenterDashboard()
        {
            Agents = new List<CallCenterDashboardAgent>{};
            Queues = new List<CallCenterDashboardQueue>{};
            Calls = new List<CallCenterDashboardCall>{};
        }

        public virtual List<CallCenterDashboardAgent> Agents { get; set; }
        public virtual List<CallCenterDashboardQueue> Queues { get; set; }
        public virtual List<CallCenterDashboardCall> Calls { get; set; }
    }

    public partial class CallCenterDashboardAgent
    {
        public CallCenterDashboardAgent()
        {
            Queues = new List<string>{};
        }

        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual List<string> Queues { get; set; }
        public virtual string AgentState { get; set; }
        public virtual string CallState { get; set; }
        public virtual string SignInTime { get; set; }
        public virtual string SignInDuration { get; set; }
        public virtual string PercentAvailable { get; set; }
        public virtual string AvgBusyIn { get; set; }
        public virtual string AvgWrapUp { get; set; }
        public virtual string DateOfLastCall { get; set; }
    }

    public partial class CallCenterDashboardCall
    {
        public virtual string Id { get; set; }
        public virtual string Customer { get; set; }
        public virtual string Queue { get; set; }
        public virtual string Agent { get; set; }
        public virtual string State { get; set; }
        public virtual string Duration { get; set; }
        public virtual string Hold { get; set; }
        public virtual string ExtraInfo { get; set; }
    }

    public partial class CallCenterDashboardQueue
    {
        public virtual string Name { get; set; }
        public virtual int NumAgents { get; set; }
        public virtual int NumCallsQueued { get; set; }
        public virtual string LongestWaitingCall { get; set; }
        public virtual string ExpectedWaitTime { get; set; }
        public virtual string ExpectedHoldTime { get; set; }
        public virtual string AverageSpeedOfAnswer { get; set; }
        public virtual int IdleAgents { get; set; }
        public virtual int UnavailableAgents { get; set; }
    }

    ///<summary>
    ///Returns the call center dashboard data
    ///</summary>
    [Api(Description="Returns the call center dashboard data")]
    public partial class GetCallCenterDashboard
        : IPost
    {
        ///<summary>
        ///The account ID to retrieve for
        ///</summary>
        [ApiMember(Description="The account ID to retrieve for")]
        public virtual string AccountId { get; set; }
    }

}

C# 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>