Evo Voice

<back to all web services

GetCallCenterDashboard

Returns the call center dashboard data

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Dashboard

Namespace Global

    Namespace Voice.Api.Dashboard

        Public Partial Class CallCenterDashboard
            Public Sub New()
                Agents = New List(Of CallCenterDashboardAgent)
                Queues = New List(Of CallCenterDashboardQueue)
                Calls = New List(Of CallCenterDashboardCall)
            End Sub

            Public Overridable Property Agents As List(Of CallCenterDashboardAgent)
            Public Overridable Property Queues As List(Of CallCenterDashboardQueue)
            Public Overridable Property Calls As List(Of CallCenterDashboardCall)
        End Class

        Public Partial Class CallCenterDashboardAgent
            Public Sub New()
                Queues = New List(Of String)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property Name As String
            Public Overridable Property Queues As List(Of String)
            Public Overridable Property AgentState As String
            Public Overridable Property CallState As String
            Public Overridable Property SignInTime As String
            Public Overridable Property SignInDuration As String
            Public Overridable Property PercentAvailable As String
            Public Overridable Property AvgBusyIn As String
            Public Overridable Property AvgWrapUp As String
            Public Overridable Property DateOfLastCall As String
        End Class

        Public Partial Class CallCenterDashboardCall
            Public Overridable Property Id As String
            Public Overridable Property Customer As String
            Public Overridable Property Queue As String
            Public Overridable Property Agent As String
            Public Overridable Property State As String
            Public Overridable Property Duration As String
            Public Overridable Property Hold As String
            Public Overridable Property ExtraInfo As String
        End Class

        Public Partial Class CallCenterDashboardQueue
            Public Overridable Property Name As String
            Public Overridable Property NumAgents As Integer
            Public Overridable Property NumCallsQueued As Integer
            Public Overridable Property LongestWaitingCall As String
            Public Overridable Property ExpectedWaitTime As String
            Public Overridable Property ExpectedHoldTime As String
            Public Overridable Property AverageSpeedOfAnswer As String
            Public Overridable Property IdleAgents As Integer
            Public Overridable Property UnavailableAgents As Integer
        End Class

        '''<Summary>
        '''Returns the call center dashboard data
        '''</Summary>
        <Api(Description:="Returns the call center dashboard data")>
        Public Partial Class GetCallCenterDashboard
            Implements IPost
            '''<Summary>
            '''The account ID to retrieve for
            '''</Summary>
            <ApiMember(Description:="The account ID to retrieve for")>
            Public Overridable Property AccountId As String
        End Class
    End Namespace
End Namespace

VB.NET GetCallCenterDashboard DTOs

GET /dashboard/call-center HTTP/1.1 
Host: evovoice.io 
Accept: text/jsv

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