| Requires any of the roles: | SystemAdministrator, Manager, CallCenterDashboard |
| GET | /dashboard/call-center |
|---|
"use strict";
export class CallCenterDashboardAgent {
/** @param {{id?:string,name?:string,queues?:string[],agentState?:string,callState?:string,signInTime?:string,signInDuration?:string,percentAvailable?:string,avgBusyIn?:string,avgWrapUp?:string,dateOfLastCall?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {string[]} */
queues;
/** @type {string} */
agentState;
/** @type {string} */
callState;
/** @type {string} */
signInTime;
/** @type {string} */
signInDuration;
/** @type {string} */
percentAvailable;
/** @type {string} */
avgBusyIn;
/** @type {string} */
avgWrapUp;
/** @type {string} */
dateOfLastCall;
}
export class CallCenterDashboardQueue {
/** @param {{name?:string,numAgents?:number,numCallsQueued?:number,longestWaitingCall?:string,expectedWaitTime?:string,expectedHoldTime?:string,averageSpeedOfAnswer?:string,idleAgents?:number,unavailableAgents?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {number} */
numAgents;
/** @type {number} */
numCallsQueued;
/** @type {string} */
longestWaitingCall;
/** @type {string} */
expectedWaitTime;
/** @type {string} */
expectedHoldTime;
/** @type {string} */
averageSpeedOfAnswer;
/** @type {number} */
idleAgents;
/** @type {number} */
unavailableAgents;
}
export class CallCenterDashboardCall {
/** @param {{id?:string,customer?:string,queue?:string,agent?:string,state?:string,duration?:string,hold?:string,extraInfo?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
customer;
/** @type {string} */
queue;
/** @type {string} */
agent;
/** @type {string} */
state;
/** @type {string} */
duration;
/** @type {string} */
hold;
/** @type {string} */
extraInfo;
}
export class CallCenterDashboard {
/** @param {{agents?:CallCenterDashboardAgent[],queues?:CallCenterDashboardQueue[],calls?:CallCenterDashboardCall[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CallCenterDashboardAgent[]} */
agents;
/** @type {CallCenterDashboardQueue[]} */
queues;
/** @type {CallCenterDashboardCall[]} */
calls;
}
export class GetCallCenterDashboard {
/** @param {{accountId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The account ID to retrieve for */
accountId;
}
JavaScript 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>