Queue Agents

Retrieve the list of agents associated with a specified queue.

GET /Queues/FIFO/{queueId}/Users/Agents

Path Parameter:

• queueId (integer): Queue identifier.

Response:

200 OK: Returns an array of agent objects with the following properties:

• username (string)

• firstName (string)

• lastName (string)

• telephoneAddress (string)

Error Responses:

• 400 – Invalid queue id

• 401 – Unauthorized

• 403 – Forbidden (requires global supervisor or instance profile view agent privileges)

• 404 – Not found

• 500 – Internal Server Error

• 504 – Gateway Timeout

Add an agent to a specified queue.

POST /Queues/FIFO/{queueId}/Users/Agents

Path Parameter:

• queueId (integer): Queue identifier.

Request Body (application/json):

• Properties:

  • username (string, required): The username of the agent to add.

Responses:

• 201 Created: Agent successfully added.

• 409 Conflict: Returned if the current resource state is invalid (e.g., user has no primary extension or is already an agent). The response may include a reason code:

  • 0: No primary extension

  • 1: User is already an agent

Error Responses:

• 400 – Validation errors

• 401 – Unauthorized

• 403 – Forbidden (requires global supervisor or instance supervisor privileges)

• 404 – Not found

• 500 – Internal Server Error

• 504 – Gateway Timeout

Remove an agent from a specified queue.

DELETE /Queues/FIFO/{queueId}/Users/Agents/{username}

Path Parameters:

• queueId (integer): Queue identifier.

• username (string): Agent's username.

Responses:

• 204 No Content: Agent successfully removed.

Error Responses:

• 400 – Invalid queue id

• 401 – Unauthorized

• 403 – Forbidden (requires global supervisor or instance supervisor privileges)

• 404 – Not found

• 500 – Internal Server Error

• 504 – Gateway Timeout

Retrieve the list of QME FIFO queues assigned to a specific agent

GET /Users/Agents/{username}/Queues

Path Parameter:

• username (string): The agent's username.

Response:

• 200 OK: Returns an array of queue objects (with properties similar to those described in GET /Queues/FIFO).

Error Responses:

• 401 – Unauthorized

• 403 – Forbidden (requires at least QME base access)

• 404 – Not found

• 500 – Internal Server Error

• 504 – Gateway Timeout

Last updated: February 25, 2025