Aggregated overview of agents, including a summary

GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/agents/aggregated

Get an aggregated list of agents in Miralix OfficeTeam, including a summary.

HTTP GET: /agents/aggregated or /agents/aggregated?state={state}&filter={filter}&values={value,value}

ParameterValueDescription
stateany, loggedIn, loggedoutFilter agents based on agent status.

any – Lists all agents that is able to login to OfficeTeam,whether logged in or not
loggedIn – Lists all agents that is logged in
loggedOut – Lists all agents that is not logged in

It is possible to omit the State parameter. This will default to loggedIn, and list all agents that is logged in.
filtertagsOr, tagsAnd, ids, inQueueFilter agents based on tags, ID's or queue membership.

tagsOr – Lists agents that has at least one of the tags listed in values
tagsAnd – Lists agents that has all tags listed in values
ids – Lists agents ith ID's listed in values
inQueue – List agents logged in and part of the queues (queue ids) listed in values

It is possible to omit the Filter parameter. Then no filter will be applied. Only state affects which agents are included.
values{String}Comma separate list of values.

Must match the selected filter. So, if ID's are selected as the filter, then values must be a list of integers.

It is only possible to omit the Values parameter when the Filter parameter has been omitted.

Example

https://192.168.1.10/mot/greenbox/agents/aggregated/ - Aggregated list of all agents logged in to OfficeTeam, including a summary https://192.168.1.10/mot/greenbox/agents/aggregated?state=any - Aggregated list of all agents that can log in to OfficeTeam, including a summary https://192.168.1.10/mot/greenbox/agents/aggregated?state=loggedout - Aggregated list of all agents not logged in to OfficeTeam, including a summary https://192.168.1.10/mot/greenbox/agents?state=loggedout&filter=tagsOr&values=sales,support - Aggregated list of all agents that is not logged in to OfficeTeam and have at least one of the mentioned agent tags https://192.168.1.10/mot/greenbox/agents?filter=ids&values=254,255 - Aggregated list of agents with an ID that matches one of the mentioned IDs https://192.168.1.10/mot/greenbox/agents?filter=inQueue&values=7,9 - Aggregated list of all agents who are logged in and are in a role associated with one of the mentioned Queue ID's

Result

A list of all possible OfficeTeam agents based on the selected filer, is now received. This includes a summary of these agents.

  • 200 OK - Aggregated list of agents that meet the requirements in the filter, as well as a summary of these agents
  • 400 Bad Request - One or more parameters are not valid
  • 500 Internal Server Error - Internal processing error

JSON result

ParameterValueDescription
Agents{array}Array of agents
↳ AgentId{Integer}Agent's ID in the database
↳ AgentForename{String}Forename
↳ AgentSurname{String}Surname
↳ AgentName{String}Agent's full name
↳ AgentEmail{String}Agent's E-mail
↳ AgentDepatmentName{String}Department name
↳ AgentDepatmentId{Integer}Department ID in the database
↳ AgentCompanyName{String}Company name
↳ AgentCompanyId{Integer}Company ID in the database
↳ AgentAddressName{String}Agent’s address
↳ AgentAddressId{Integer}Agent’s address ID in the database
↳ AgentSipUri{String}Agent’s SIP URI
↳ AgentSyncId{String}Agent's Sync ID (UUID), if imported via Miralix DataImport
↳ CallCenterTimeUtc{date-time: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'}Current time on the server (UTC)
↳ StateChangedUtc{date-time: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'}Time of agent's last status change (UTC)
↳ StateAwait, Alerting, Idle, Busy, Ready, Quarantined, Paused, Acwt, Login, Logout, Resume, None, SkipQuarantine, SkipAcwtAgent status (Acwt = After call work time)
↳ ApplicationTypePcClient, MobileClientType of Miralix client
↳ ClientApplication{String}Miralix client name and version
↳ TransferTypeSupervised, SingleStep, DtmfSupervised, DtmfDualline, Dualline, ClientOfferSingleStep, ClientOfferSupervised, ClientOfferDuallineTransfer type selected for the agent
↳ Role{object}, nullThe agent’s current role
↳↳ Id{Integer}Role ID
↳↳ Name{String}Role name
↳ BusyCall{object}, nullAgent's ongoing OfficeTeam call.
This is only an object if the Agent answered the Queue Call directly.
↳↳ AgentId{Integer}Agent's ID in the database
↳↳ AgentName{String}Agent's full name
↳↳ AgentEmail{String}Agent's E-mail
↳↳ AgentSipUri{String}Agent's SIP URI
↳↳ AgentSyncId{String}Agent's Sync ID (UUID), if imported via Miralix DataImport
↳↳ QueueId{Integer}Call offered/answered from this Queue ID
↳↳ QueueName{String}Call offered/answered from this Queue name
↳↳ QueueTypeDistribution, PickupAgent sees this Queue as this type
↳↳ QueueBehaviorTypeNormal, CampOnBusy, Parking, PersonalAgent sees this Queue behavior as this type
↳↳ QueueCallId{Integer}Queue call ID (QueueCallId) in Miralix Office Team
↳↳ QueueCallTypeQueueCall, CallbackCallQueue call type
↳↳ Language{String: ISO Language Code}The language to which the call is linked in Miralix Office Team
↳↳ CallCenterTimeUtc{date-time: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'}Current time on the server (UTC)
↳↳ ReceivedQueueUtc{date-time: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'}The time the call arrived in the queue (UTC).
↳↳ LeftQueueUtc{date-time: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'}The time the call left the queue (UTC).
0001-01-01T00:00:00 if the call has not been answered.
↳↳ WaitintQueueTime{TimeStamp: d.HH:mm:ss.SSSSSSS}Waiting time in the queue
↳↳ Called{String}The called number
↳↳ Calling{String}The number of the caller
↳↳ Transferred{String}The number of the person who transferred the call
↳↳ OriginalCalling{String}The number of the person who originally called (A number)
↳↳ QueueContentTypeAudioQueue content type
↳↳ TaskSubject{String}Task Subject
↳ Note{object}, nullThe agent’s current note
↳↳ Id{Integer}Note ID in the database
↳↳ Text{String}The name of the note
↳↳ NoteFunction{String}
CallForwardingAlways, DoNotDisturb, None
“CallForwardingAlways” – Work phone is forwarded
“DoNotDisturb” – Work phone is set to ”Do Not Disturb” (Dnd)
”None” - Only indicates that the note is active
↳↳ ForwardedTo{String}Shows what number the work phone is forwarded to
↳ Tags{array}Array of tags on the agent
↳↳ Agent tag{String}
AgentCount{Integer}Number of agents found
LoggedInAgents{Integer}Number of agents logged in
LoggedOutAgents{Integer}Number of agents logged out
ReadyAgents{Integer}Number of agents ready
BusyAgents{Integer}Number of busy agents
AlertingAgents{Integer}Number of agents being offered a call
PausedAgents{Integer}Number of agents paused
AcwtAgents{Integer}Number of agents in After call work time (Acwt)
QuarantinedAgents{Integer}Number of agents in quarantine

Request Params

KeyDatatypeRequiredDescription
statestringFilter agents based on agent status. Example: any
filterstringFilter agents based on tags, ID's or queue membership. Example: inQueue
valuesstringComma separate list of values. Example: {{callsQueueId}}

RESPONSES

status: OK

{"Agents":[{"AgentId":19,"AgentForename":"Benjamin","AgentSurname":"Davis","AgentName":"Benjamin Davis","AgentEmail":"bejdav@mrxlab.local","AgentDepartmentName":"Support","AgentDepartmentId":50,"AgentCompanyName":"Miralix Help","AgentCompanyId":53,"AgentAddressName":"Help Street 66","AgentAddressId":384,"AgentSipUri":"","AgentSyncId":"f38c6691-0469-4ddd-a77f-8c63ed7ffd25","CallCenterTimeUtc":"2022-12-14T11:13:44.5152336Z","StateChangedUtc":"2022-12-14T09:16:27.0798663Z","State":"Busy","ApplicationType":"PcClient","ClientApplication":"Miralix Desktop v6.5.68","TransferType":"Dualline","Role":{"Id":0,"Name":"Default"},"BusyCall":{"AgentId":19,"AgentName":"Benjamin Davis","AgentEmail":"bejdav@mrxlab.local","AgentSipUri":"","AgentSyncId":"f38c6691-0469-4ddd-a77f-8c63ed7ffd25","QueueId":19,"QueueName":"Miralix kø1","QueueType":"Distribution","QueueBehaviorType":"Normal","QueueCallId":104171,"QueueCallType":"QueueCall","Language":"da-DK","CallCenterTimeUtc":"2022-12-14T11:13:44.5153357Z","ReceivedQueueUtc":"2022-12-14T09:16:22.7966941Z","LeftQueueUtc":"2022-12-14T09:16:27.4377836Z","WaitingQueueTime":"00:00:04.6410895","Called":"780","Calling":"+4572311784","Transferred":"","OriginalCalling":"+4572311784","QueueContentType":"Audio","TaskSubject":""},"Note":null,"Tags":["Support","QA"]}],"AgentCount":1,"LoggedInAgents":1,"LoggedOutAgents":0,"ReadyAgents":0,"BusyAgents":1,"AlertingAgents":0,"PausedAgents":0,"AcwtAgents":0,"QuarantinedAgents":0}