| Requires any of the roles: | SystemAdministrator, Manager, CallCenterDashboard |
| 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 .xml suffix or ?format=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>