Pick up a call from a pickup queue, on behalf of an agent

POST {{httptype}}://{{IP}}/mot/{{miralixAccount}}/agents/{{identificationType}}/{{TypeID}}/calls/{{QueueCallId}}/pickupCall

Pick up a call from a pickup queue, on behalf of an agent. The agent needs to be member of the pickup queue, and in a skill that is allowed to pick up the call at that current time.

HTTP POST: /agents/{identificationType}/{identification}/calls/{queueCallId}/pickupCall

ParameterValueDescription
identificationTypesipUri, id, email, syncIdDifferent identification types, that can be used to identify an agent
identification{String}The identification value must match the selected identification type. So if identificationType is set to email, then the identification value must match an agents email
queueCallId{Integer}Queue call id on the call that is to be answered

Example

https://192.168.1.10/mot/greenbox/agents/id/103/calls/127/pickupCall - Pick up call with queueCallId 127, for agent with id 103
https://192.168.1.10/mot/greenbox/agents/email/derek.a@company.local/calls/127/pickupCall - Pick up call with queueCallId 127, for agent with email derek.a@company.local
https://192.168.1.10/mot/greenbox/agents/syncId/f4fd9e5f-017d-4350-adf8-8dd811bc1a2e/calls/127/pickupCall - Pick up call with queueCallId 127, for agent with syncId f4fd9e5f-017d-4350-adf8-8dd811bc1a2e

Resultat

The OfficeTeam service informs the agent's client that the agent must pick the call. The client then tells the OfficeTeam service that it wants to pick up the specified call. Thereby the call is sent to the agent.

  • 200 OK - A request to pick a queue call is sent to the agent's client.
  • 400 Bad Request - One or more parameters are not valid, or it is not possible to find correct data about the agent.
  • 403 Forbidden - Missing required License to access this request.
  • 404 Not Found - The agent is not logged in or does not exist.
  • 500 Internal Server Error - Internal processing error.