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
GetCallCenterDashboard Parameters:
NameParameterData TypeRequiredDescription
AccountIdquerystringNoThe account ID to retrieve for
CallCenterDashboard Parameters:
NameParameterData TypeRequiredDescription
AgentsformList<CallCenterDashboardAgent>No
QueuesformList<CallCenterDashboardQueue>No
CallsformList<CallCenterDashboardCall>No
CallCenterDashboardAgent Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
QueuesformList<string>No
AgentStateformstringNo
CallStateformstringNo
SignInTimeformstringNo
SignInDurationformstringNo
PercentAvailableformstringNo
AvgBusyInformstringNo
AvgWrapUpformstringNo
DateOfLastCallformstringNo
CallCenterDashboardQueue Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
NumAgentsformintNo
NumCallsQueuedformintNo
LongestWaitingCallformstringNo
ExpectedWaitTimeformstringNo
ExpectedHoldTimeformstringNo
AverageSpeedOfAnswerformstringNo
IdleAgentsformintNo
UnavailableAgentsformintNo
CallCenterDashboardCall Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CustomerformstringNo
QueueformstringNo
AgentformstringNo
StateformstringNo
DurationformstringNo
HoldformstringNo
ExtraInfoformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}