Skip to content
Dixa API/
/
Create queue

Create queue

Request

Create a queue.

Security
ApiKeyAuth(Required scopes: settings.queue:w)
Bodyapplication/jsonrequired

The details for creating a queue

requestobject(CreateOrUpdateQueueRequest)required
POST
/v1/queues
curl -i -X POST \
  https://dev.dixa.io/v1/queues \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "request": {
      "name": "MyCorp main queue",
      "callFunctionality": false,
      "isDefault": true,
      "queueThresholds": {
        "WaitingConversations": 10
      },
      "offerTimeout": 10,
      "offerAlgorithm": "AllAtOnce",
      "wrapupTimeout": 10,
      "priority": 1,
      "offerAbandonedConversations": false,
      "doNotOfferTimeouts": {
        "WidgetChat": 1
      },
      "isDoNotOfferEnabled": true,
      "preferredAgentTimeouts": {
        "WhatsApp": 300,
        "Voicemail": 300,
        "WidgetChat": 300,
        "FacebookMessenger": 300,
        "Email": 43200,
        "ContactForm": 43200,
        "Callback": 300,
        "PstnPhone": 300
      },
      "isPreferredAgentEnabled": false,
      "preferredAgentOfflineTimeout": 500,
      "personalAgentOfflineTimeout": 500,
      "isRestricted": false
    }
  }'

Responses

The created queue

Bodyapplication/json
dataobject(Queue)required
Response
{
  "data": {
    "id": "string",
    "name": "string",
    "isDefault": true,
    "organizationId": "string",
    "queueThresholds": { … },
    "slaCalculationMethod": "string",
    "offerTimeout": 0,
    "offeringAlgorithm": "string",
    "memberListType": "string",
    "usages": { … },
    "wrapupTimeout": 0,
    "priority": 0,
    "offerAbandonedConversations": true,
    "doNotOfferTimeouts": { … },
    "isDoNotOfferEnabled": true,
    "isPreferredAgentEnabled": true,
    "preferredAgentTimeouts": { … },
    "preferredAgentOfflineTimeout": 0,
    "personalAgentOfflineTimeout": 0,
    "isRestricted": true
  }
}