Skip to content
Dixa API/
/
List agents

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

List queues

Request

List all queues in an organization.

Security
ApiKeyAuth
curl -i -X GET \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/queues \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of queues in an organization

Bodyapplication/json
dataArray of objects(Queue)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Create queue

Request

Create a queue.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The details for creating a queue

requestobject(CreateOrUpdateQueueRequest)required
request.​namestringrequired
request.​callFunctionalitybooleanrequired
request.​isDefaultbooleanrequired
request.​queueThresholdsobject(Map_QueueThreshold_Int)

values: [SlaTimeLimit, AvailableAgents, LongestWait, SlaPercentage, WaitingConversations]

request.​offerTimeoutinteger(int32)
request.​offerAlgorithmstring

values: [AgentPriorityOneAtATimeRandom, AllAtOnce, AgentPriorityLongestIdle, AgentPriorityAllAtOnce, LongestIdle, OneAtATimeRandom]

request.​wrapupTimeoutinteger(int32)
request.​priorityinteger(int32)
request.​offerAbandonedConversationsboolean
request.​doNotOfferTimeoutsobject(Map_ConversationChannel_Int)

values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]

request.​isDoNotOfferEnabledbooleanrequired
request.​preferredAgentTimeoutsobject(Map_ConversationChannel_Int)

values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]

request.​isPreferredAgentEnabledboolean
request.​preferredAgentOfflineTimeoutinteger(int32)
request.​personalAgentOfflineTimeoutinteger(int32)
request.​isRestrictedboolean
curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/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
data.​idstringrequired
data.​namestringrequired
data.​isDefaultbooleanrequired
data.​organizationIdstringrequired
data.​queueThresholdsobject(Map_QueueThreshold_Int)required

values: [SlaTimeLimit, AvailableAgents, LongestWait, SlaPercentage, WaitingConversations]

data.​queueThresholds.​property name*integer(int32)additional property
data.​slaCalculationMethodstringrequired

values: [AbandonedIgnored]

data.​offerTimeoutinteger(int32)
data.​offeringAlgorithmstring

values: [AgentPriorityOneAtATimeRandom, AllAtOnce, AgentPriorityLongestIdle, AgentPriorityAllAtOnce, LongestIdle, OneAtATimeRandom]

data.​memberListTypestring

values: [Default, SkillBased]

data.​usagesobject(QueueUsages)
data.​wrapupTimeoutinteger(int32)
data.​priorityinteger(int32)
data.​offerAbandonedConversationsboolean
data.​doNotOfferTimeoutsobject(Map_ConversationChannel_Int)required

values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]

data.​doNotOfferTimeouts.​property name*integer(int32)additional property
data.​isDoNotOfferEnabledbooleanrequired
data.​isPreferredAgentEnabledboolean
data.​preferredAgentTimeoutsobject(Map_ConversationChannel_Int)

values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]

data.​preferredAgentOfflineTimeoutinteger(int32)
data.​personalAgentOfflineTimeoutinteger(int32)
data.​isRestrictedboolean
Response
application/json
{
  "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
  }
}

List agents

Request

List all agents/admins that are members of a queue by providing the queue id.

Security
ApiKeyAuth
Path
queueIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/queues/{queueId}/members' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of the agents/admins that are members of a queue

Bodyapplication/json
dataArray of objects(QueueMember)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Remove agents

Request

Bulk remove agents/admins from the specified queue.

Security
ApiKeyAuth
Path
queueIdstring(uuid)required
Bodyapplication/jsonrequired

The list of agents/admins to be removed from the queue. Up to 10 members can be specified.

agentIdsArray of strings(uuid)unique
curl -i -X DELETE \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/queues/{queueId}/members' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "agentIds": [
      "743c3781-c882-4352-a1fa-fe5d7a673cfd",
      "cad2f234-8cec-4cd8-96e9-a6491a0176da"
    ]
  }'

Responses

The bulk operation succeeded

Response
No content

Assign agents

Request

Assign one or more agents/admins to a given queue.

Security
ApiKeyAuth
Path
queueIdstring(uuid)required
Bodyapplication/jsonrequired

The list of agents/admins to be added to the queue

agentIdsArray of strings(uuid)unique
curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/queues/{queueId}/members' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "agentIds": [
      "c31e5e3f-1d5f-4442-83df-fd7bddd59da4",
      "26ae145b-8644-4fa5-aa56-7b3dcacbe2d4"
    ]
  }'

Responses

The list of patch action outcomes

Bodyapplication/json
dataArray of BulkActionFailure_BulkError_UUID (object) or BulkActionSuccess_BulkError_UUID (object)(BulkActionOutcome_BulkError_UUID)
Response
application/json
{
  "data": [
    { … },
    { … },
    { … }
  ]
}

Get queue availability

Request

Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat.

Security
ApiKeyAuth
Path
queueIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/queues/{queueId}/availability' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The availability of supported channels for a given queue

Bodyapplication/json
dataArray of Failure (object) or Success (object)(ChannelAvailabilityOutcome)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Get queue

Request

Get a queue by id.

Security
ApiKeyAuth
Path
queueIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/queues/{queueId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The queue

Bodyapplication/json
dataobject(Queue)required
data.​idstringrequired
data.​namestringrequired
data.​isDefaultbooleanrequired
data.​organizationIdstringrequired
data.​queueThresholdsobject(Map_QueueThreshold_Int)required

values: [SlaTimeLimit, AvailableAgents, LongestWait, SlaPercentage, WaitingConversations]

data.​queueThresholds.​property name*integer(int32)additional property
data.​slaCalculationMethodstringrequired

values: [AbandonedIgnored]

data.​offerTimeoutinteger(int32)
data.​offeringAlgorithmstring

values: [AgentPriorityOneAtATimeRandom, AllAtOnce, AgentPriorityLongestIdle, AgentPriorityAllAtOnce, LongestIdle, OneAtATimeRandom]

data.​memberListTypestring

values: [Default, SkillBased]

data.​usagesobject(QueueUsages)
data.​wrapupTimeoutinteger(int32)
data.​priorityinteger(int32)
data.​offerAbandonedConversationsboolean
data.​doNotOfferTimeoutsobject(Map_ConversationChannel_Int)required

values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]

data.​doNotOfferTimeouts.​property name*integer(int32)additional property
data.​isDoNotOfferEnabledbooleanrequired
data.​isPreferredAgentEnabledboolean
data.​preferredAgentTimeoutsobject(Map_ConversationChannel_Int)

values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]

data.​preferredAgentOfflineTimeoutinteger(int32)
data.​personalAgentOfflineTimeoutinteger(int32)
data.​isRestrictedboolean
Response
application/json
{
  "data": {
    "id": "0bf82493-ae46-4c49-aa29-0422136269be",
    "name": "MyCorp main queue",
    "isDefault": true,
    "organizationId": "3de6c0f1-5e84-4d29-9ce9-84033983d4e6",
    "queueThresholds": { … },
    "slaCalculationMethod": "AbandonedIgnored",
    "offerTimeout": 10,
    "offeringAlgorithm": "OneAtATimeRandom",
    "memberListType": "SkillBased",
    "usages": { … },
    "wrapupTimeout": 10,
    "priority": 1,
    "offerAbandonedConversations": false,
    "doNotOfferTimeouts": { … },
    "isDoNotOfferEnabled": true,
    "isPreferredAgentEnabled": false,
    "preferredAgentTimeouts": { … },
    "preferredAgentOfflineTimeout": 500,
    "personalAgentOfflineTimeout": 500,
    "isRestricted": true
  }
}

Get the position of the conversation in its current queue

Request

Get the approximate position of a given conversation in its current queue.

Security
ApiKeyAuth
Path
csidinteger(int64)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/queues/conversation-position/{csid}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The position of the conversation in the queue

Bodyapplication/json
dataobject(QueuedConversation)required
data.​positioninteger(int32)

Approximate position of the conversation in the current queue

data.​queuedAtstring(date-time)required
Response
application/json
{
  "data": {
    "position": 10,
    "queuedAt": "2021-12-01T13:00:00.003Z"
  }
}

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations