Queues Management

Retrieve a list of QME FIFO queues

GET /Queues/FIFO

Query Parameters:

• tenantId (string): Filter queues by the tenant id.
  Example: 6649e002-65ec-4eab-a4d6-7f3d493a1311

Responses:

200 OK: Returns an array of queue objects.

• Queue Object Properties:

  • id (integer): Queue identifier.
    Example: 561814

  • name (string): Queue name.
    Example: Queue-US

  • phoneNumber (string): Queue telephone number.
    Example: '668001'

  • tenantId (string): Tenant identifier.

  • canViewRealTimeStats (boolean): Indicates if the user can view real-time statistics.

  • priority (object):

    • value (integer): Current priority value.
      Example: 5

    • override (boolean): Whether the global default was overridden.

  • loginLogoutPhoneNumber (object):

    • value (string): The telephone prefix for login (suffix "1") and logout (suffix "0").
      Example: '41578'

    • override (boolean): Whether the global default was overridden.

  • maxWaitingCalls (object):

    • value (integer): Maximum waiting calls (0 indicates no limit).
      Example: 10

    • override (boolean): Whether the global default was overridden.

Error Responses:

401 – Unauthorized

403 – Forbidden (requires at least QME base access)

500 – Internal Server Error

504 – Gateway Timeout

Create a new QME FIFO queue.

POST /Queues/FIFO

Request Body (application/json):

• Properties:

  • name (string, maxLength: 50, required): Name of the new queue.
    Example: Queue-US

  • phoneNumber (string or array, maxLength: 255, required): Telephone address (omit "sip:" if SIP URI).
    Example: ['668001', 'john@imagicle.com']

  • tenantId (string): Tenant id. Set to null to use the default.

  • priority (object):

    • value (integer, minimum: 0): Target priority (used only if override is true).
      Example: 3

    • override (boolean, default: false): Whether to override the global default.

  • loginLogoutPhoneNumber (object):

    • value (string, maxLength: 255): Target login/logout telephone address.
      Example: '41578'

    • override (boolean, default: false): Whether to override the global default.

  • maxWaitingCalls (object):

    • value (integer, minimum: 0): Target maximum waiting calls (0 means "no limit").
      Example: 10

    • override (boolean, default: false): Whether to override the global default.

Responses:

201 Created:

• Returns a JSON object containing the id (integer) of the newly created queue. Example: { "id": 561814 }

Error Responses:

400 – Validation errors (e.g., missing parameters, invalid values)

401 – Unauthorized

403 – Forbidden (requires QME complete management authorization)

409 – Conflict (e.g., queue with given name or telephone already exists)

500 – Internal Server Error

504 – Gateway Timeout

Modify specific fields of an existing QME FIFO queue.

PATCH /Queues/FIFO/{queueId}

Path Parameter:

• queueId (integer): Identifier of the queue to update.
  Example: 561814

Request Body (application/merge-patch+json):

• JSON Merge Patch object. Any fields not provided will remain unchanged.

Updatable Fields:

• name (string, maxLength: 50)

• phoneNumber (string, maxLength: 255)

• tenantId (string)

• priority (object with value and override)

• loginLogoutPhoneNumber (object with value and override)

• maxWaitingCalls (object with value and override)

Responses:

204 No Content: Queue successfully updated.

Error Responses:

400 – Validation errors

401 – Unauthorized

403 – Forbidden (requires QME complete management authorization)

404 – Not found

409 – Conflict

500 – Internal Server Error

504 – Gateway Timeout

Delete an existing QME FIFO queue

DELETE /Queues/FIFO/{queueId}

Purpose: .

Path Parameter:

• queueId (integer): Identifier of the queue to delete.

Responses:

204 No Content: Queue successfully deleted.

Error Responses:

400 – Invalid queue id

401 – Unauthorized

403 – Forbidden (requires QME complete management authorization)

404 – Not found

500 – Internal Server Error

504 – Gateway Timeout

Last updated: February 25, 2025