Overview of all Agents for a specific queue

GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/{{callsQueueId}}/agents?state=any

Get an overview of agents that is assigned to a specific queue, including the roles that associate the agent with the queue.

HTTP GET: /queues/{queueId}/agents?state={state}

ParameterValueDescription
queueIdIntegerID for a queue
stateany, loggedIn, loggedoutFilter agents based on agent status.

any – Lists all agents that has a role that includes the specified queue, whether logged in or not
loggedIn – Lists all agents that is logged in, and is active in a role that includes the specific queue
loggedOut – Lists all agents that is not logged in, but has a role that inludes the specified queue

It is possible to omit the State parameter. This will default to loggedIn, and list all agents that is logged in.

Example

https://192.168.1.10/mot/greenbox/queues/301/agents - Get overview of all agents that logged in, and that is active in a role that includes the queue with ID 301
https://192.168.1.10/mot/greenbox/queues/301/agents?state=any - Get overview of all agents, that has a tole that includes the queue with ID 301
https://192.168.1.10/mot/greenbox/queues/301/agents?state=loggedout - Get overview of all agents that is not logged in, that has a tole that includes the queue with ID 301

Result

  • 200 OK - Overview of agents for the specific queue.
  • 400 Bad Request - One or more parameters are not valid.
  • 403 Forbidden - Missing required License to access this request.
  • 404 Not Found - The queue could not be found.
  • 500 Internal Server Error - Internal processing error.

JSON result

For hver agent, vises følgende

ParameterValueDescription
AgentId{Integer}Agent's ID in the database
AgentForename{String}Forename
AgentSurname{String}Surname
AgentName{String}Full name
AgentEmail{String}E-mail
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)
StateAwait, Alerting, Idle, Busy, Ready, Quarantined, Paused, Acwt, Login, Logout, Resume, None, SkipQuarantine, SkipAcwt, nullAgent status (Acwt = After call work time)
ApplicationTypePcClient, MobileClient, nullType of Miralix client
ClientApplication{String}Miralix client name and version
TransferTypeSupervised, SingleStep, DtmfSupervised, DtmfDualline, Dualline, ClientOfferSingleStep, ClientOfferSupervised, ClientOfferDualline, nullTransfer 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 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
↳ 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
PrivateCall{object}, nullAgent'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
↳ CallDirectionIn, OutDirection 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}, nullThe agent’s current note
↳ Id{Integer}Note ID in the database
↳ Text{String}The name of the note
↳ NoteFunctionCallForwardingAlways, DoNotDisturb, NoneCallForwardingAlways – 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}
Tags{array}Array of roles where the specified queue is included
↳ Id{Integer}Role ID
↳ Name{String}Role name
↳ Queues{array}The ID, name and the Skill for the specified queue
↳↳ Id{Integer}Queue ID
↳↳ Name{String}Queue name
↳↳ Skill{Integer}The skill the agent is assigned for this queue in this Role
↳↳ SpectatortrueThis is only shown if the Agent is Spectator of this queue

Request Params

KeyDatatypeRequiredDescription
statestringFilter agents based on agent status. Example: any

RESPONSES

status: OK

[{"AgentId":4,"AgentForename":"R8","AgentSurname":"Nec4","AgentName":"R8 Nec4","AgentEmail":"rn4@mrxlab.local","AgentDepartmentName":"Race Cars","AgentDepartmentId":57,"AgentCompanyName":"Miralix Cars","AgentCompanyId":52,"AgentAddressName":"Le Mans Street","AgentAddressId":384,"AgentSipUri":"","AgentSyncId":"3621fb95-dc8c-4da8-b936-d419e7ead05c","CallCenterTimeUtc":"2023-03-10T12:56:14.6847241Z","StateChangedUtc":"0001-01-01T00:00:00","State":null,"ApplicationType":null,"ClientApplication":null,"TransferType":null,"Role":null,"BusyCall":null,"PrivateCall":null,"Note":null,"Tags":[],"Roles":[{"Id":0,"Name":"Default","Queues":[{"Id":19,"Name":"Miralix kø1","Skill":6}]}]},{"AgentId":19477,"AgentForename":"Master","AgentSurname":"Sip5 Gateway","AgentName":"Master Sip5 Gateway","AgentEmail":"ms85@mrxlab.local","AgentDepartmentName":"Classic Cars","AgentDepartmentId":55,"AgentCompanyName":"Miralix Cars","AgentCompanyId":52,"AgentAddressName":"Route 66","AgentAddressId":382,"AgentSipUri":"","AgentSyncId":"bc53bbff-a790-4d4b-b19d-5176578bf490","CallCenterTimeUtc":"2023-03-10T12:56:14.6847355Z","StateChangedUtc":"0001-01-01T00:00:00","State":null,"ApplicationType":null,"ClientApplication":null,"TransferType":null,"Role":null,"BusyCall":null,"PrivateCall":null,"Note":null,"Tags":[],"Roles":[{"Id":821,"Name":"2 Much 4 Lite","Queues":[{"Id":19,"Name":"Miralix kø1","Skill":9}]},{"Id":0,"Name":"Default","Queues":[{"Id":19,"Name":"Miralix kø1","Skill":9}]}]}]