Agent overview
GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/agents
Get a list of all agents in Miralix OfficeTeam. Including agent ID, name, and status.
HTTP GET: /agents or /agents?state={state}&filter={filter}&values={value,value}
| Parameter | Value | Description |
|---|---|---|
| state | any, loggedIn, loggedout | Filter 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. |
| filter | tagsOr, tagsAnd, ids, inQueue | Filter 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 - All agents logged in to OfficeTeam
https://192.168.1.10/mot/greenbox/agents?state=any - All agents who can log in to OfficeTeam
https://192.168.1.10/mot/greenbox/agents?state=loggedout - All agents who are not logged in to OfficeTeam
https://192.168.1.10/mot/greenbox/agents?state=loggedout&filter=tagsOr&values=sales,support - 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,256 - Agents with an ID that matches one of the mentioned IDs
https://192.168.1.10/mot/greenbox/agentsfilter=inQueue&values=7,9 - All agents who are logged in and are in a role associated with one of the mentioned Queue IDs
Result
A filtered list of all possible OfficeTeam agents who are logged in, logged out, or both is now received.
- 200 OK - A list of agents
- 400 Bad Request - One or more parameters are not valid
- 500 Internal Server Error - Internal processing error
JSON result
For each agent, the following data is displayed:
| Parameter | Value | Description |
|---|---|---|
| AgentId | {Integer} | Agent's ID in the database |
| AgentForename | {String} | Forename |
| AgentSurname | {String} | Surname |
| AgentName | {String} | Full name |
| AgentEmail | {String} | |
| AgentDepartmentName | {String} | Department name |
| AgentDepartmentId | {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) |
| State | Await, Alerting, Idle, Busy, Ready, Quarantined, Paused, Acwt, Login, Logout, Resume, None, SkipQuarantine, SkipAcwt, null | Agent status (Acwt = After call work time) |
| ApplicationType | PcClient, MobileClient, null | Type of Miralix client |
| ClientApplication | {String} | Miralix client name and version |
| TransferType | Supervised, SingleStep, DtmfSupervised, DtmfDualline, Dualline, ClientOfferSingleStep, ClientOfferSupervised, ClientOfferDualline, null | Transfer type selected for the agent |
| Role | {object}, null | The agent’s current role |
| ↳ Id | {Integer} | Role ID |
| ↳ Name | {String} | Role name |
| BusyCall | {object}, null | Agent's ongoing OfficeTeam call. This is only an object if the Agent is being offered or has 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 |
| ↳ QueueType | Distribution, Pickup | Agent sees this Queue as this type |
| ↳ QueueBehaviorType | Normal, CampOnBusy, Parking, Personal | Agent sees this Queue behavior as this type |
| ↳ QueueCallId | {Integer} | Queue call ID (QueueCallId) in Miralix Office Team |
| ↳ QueueCallType | QueueCall, CallbackCall | Queue 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) |
| ↳ QueueContentType | Audio | Queue content type |
| ↳ TaskSubject | {String} | Task Subject |
| PrivateCall | {object}, null | Agent's ongoing Direct call. This is only an object if the Agent is being offered or is in an ingoing or outgoing call. |
| ↳ CallCenterTimeUtc | {date-time: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'} | Current time on the server (UTC) |
| ↳ CreatedUtc | {date-time: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'} | The time the call arrived in the system (UTC) |
| ↳ Duration | {String} | Duration of the current call, including the time the call was offered to the Agent |
| ↳ CallDirection | In, Out | Direction of the call. Did the Agent answer or make the call |
| ↳ Caller | {String} | The number of the caller |
| ↳ Called | {String} | The called number |
| Note | {object}, null | The agent’s current note |
| ↳ Id | {Integer} | Note ID in the database |
| ↳ Text | {String} | The name of the note |
| ↳ NoteFunction | 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} |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
state | string | Filter agents based on agent status. Example: any | |
filter | string | Filter agents based on tags, ID's or queue membership. Example: inQueue | |
values | string | Comma separate list of values. Example: {{callsQueueId}} |
RESPONSES
status: OK
[{"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":""},"PrivateCall":null,"Note":null,"Tags":["Support","QA"]},{"AgentId":73,"AgentForename":"Emma","AgentSurname":"Smith","AgentName":"Emma Smith","AgentEmail":"emma.s@company.local","AgentDepartmentName":"Sales","AgentDepartmentId":69,"AgentCompanyName":"Miralix Gold","AgentCompanyId":52,"AgentAddressName":"Rockefeller Street 66","AgentAddressId":369,"AgentSipUri":"","AgentSyncId":"bc7cd015-1018-424c-b5c6-e6b76c91769f","CallCenterTimeUtc":"2022-12-14T11:13:44.5150792Z","StateChangedUtc":"2022-12-14T11:11:32.0673355Z","State":"Ready","ApplicationType":"PcClient","ClientApplication":"Miralix OfficeOperator v6.5.59","TransferType":"Dualline","Role":{"Id":0,"Name":"Default"},"BusyCall":null,"PrivateCall":null,"Note":null,"Tags":["Sales"]}]