Create a version for a queue

You can make a POST request to create a new version of a queue. You'll need MANAGE_ALL_QUEUES permissions to perform this operation. You can create multiple versions of a queue to test and refine a queue. You can also use queue versions to have variations that you can use with different campaigns.

The priority-based parameters, such as minPriority and maxPriority, are used to determine the order of interactions in the queue

Request

Sample request

The request below creates a new version of a queue:

curl -X POST -H "Content-Type: application/json" 
https://api.cxengage.net/v1/tenants/<tenantId>
/queues/<queueId>/versions -d'
 {
	"name": "Sales V1",
	"description": "Sales Queue",
	"minPriority": 1,
	"maxPriority": 1000,
	"priorityValue": 1,
	"priorityRate": 10,
	"priorityUnit": "minutes",
	"queryVersion": 2,
	"query": "",
	"slaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Request parameters

The table below lists the parameters you can include in a request:

Parameter Required Type Description
tenantId yes UUID The unique identifier of the tenant.
queueId yes UUID The queue's unique identifier.
name yes string The human-readable name of the queue.
description no string

A short description of the version.
minPriority no string An integer between 1 and 1000. The default is 1. This must be less than or equal to maxPriority. By default, maxPriority is set to 1000.
maxPriority no string

An integer between 1 and 1000. The default is 1000. This must be greater than or equal to minPriority. By default, minPriority is set to 1.
priorityValue no string

An integer between 1 and 1000. The default is 1.

priorityRate no string

An integer between 1 and 1000. The default is 10. This must be greater than or equal to minPriority.
priorityUnit no string

Can be seconds, minutes, hours, or days. The default is seconds.
queryVersion no string

Specifies the query type used to create this query. The value should be 2.

  This parameter is technically optional. However, if you don't specify the queryVersion as 2, it defaults to 1, which is technically not supported.
query no object

An object containing resources and values that CxEngage uses to search for agents to whom CxEngage routes calls. For more information on how to write a queue query, see Writing Queue Queries using the Advanced Query Editor.
slaId no UUID The unique identifier for the Service Level Agreement (SLA) assigned to this queue version. If a specific SLA is not assigned to the queue version, the tenant's default SLA is used for the queue.

Response

Sample response

The request returns JSON structured like the example below:

Copy 
{
    "result": {
        "tenantId": "2336d1ec-c956-47e1-b3b1-fe8fde81b2b4",
        "description": "Sales Queue",
        "minPriority": 1,
        "createdBy": "e05468e0-82b1-11e7-b08f-6e56a766befb",
        "platformQueueId": 3687,
        "slaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Sales V1",
        "created": "2018-12-11T14:37:05Z",
        "priorityRate": 10,
        "priorityValue": 1,
        "maxPriority": 1000,
        "version": "3b5c7220-fd52-11e8-b40a-4b7835b59bed",
        "query": "",
        "queueId": "3703e470-834a-11e7-b08f-6e56a766befb",
        "priorityUnit": "minutes",
        "queryVersion": 2
    }
}

Response parameters

The response includes the following parameters:

Parameter Type Description
tenantId UUID The unique identifier of the tenant.
description string A short description of the version.
minPriority string An integer between 1 and 1000. The default is 1. This must be less than or equal to maxPriority. By default, maxPriority is set to 1000.
createdBy string The unique identifier of the user who created the queue.
platformQueueId integer The integer value that a third-party Workforce Management (WFM) can use to associate with the CxEngage queue. This value is auto generated when the queue is created, and cannot be manually assigned or updated.
slaId UUID The unique identifier for the Service Level Agreement (SLA) assigned to this queue version. If a specific SLA is not assigned to the queue version, the tenant's default SLA is used for the queue.
name string The human-readable name of the queue.
created string The date and time (in UTC format) when the queue was created.
priorityRate string An integer between 1 and 1000. The default is 10. This must be greater than or equal to minPriority.
maxPriority string

An integer between 1 and 1000. The default is 1000. This must be greater than or equal to minPriority. By default, minPriority is set to 1.
version UUID

The unique identifier for the version of the queue.

query object An object containing resources and values that CxEngage uses to search for agents to whom CxEngage routes calls. For more information on how to write a queue query, see Writing Queue Queries using the Advanced Query Editor.
queueId UUID The queue's unique identifier.
priorityUnit string Can be seconds, minutes, hours, or days. The default is seconds.
queryVersion string

Specifies the query type used to create this query. The value should be 2.

  This parameter is technically optional. However, if you don't specify the queryVersion as 2, it defaults to 1, which is technically not supported.