Auto Distribution
You need the Manage Settings permission to manage Auto Distrubution
Auto Distribution
- Auto Distribution Manage
GET livechat/autoDistributionConfig
POST livechat/autoDistributionConfig:disable
POST livechat/autoDistributionConfig:enable
PUT livechat/autoDistributionConfig
Model
Auto Distribution JSON Format
Auto Distribution is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
isEnabled |
bool | Whether auto distribution is enabled or not. |
autoDistributionMethod |
string | Allowed values are "loadBalancing", "roundRobin", "capabilityWeighted". |
isLastChattedAgentPreferredForAutoDistribution |
bool | Whether the last-chatted agent is preferred or not. |
ifLimitMaxConcurrentChatsForAllAgents |
bool | Whether to set the same maximum number of chats for all agents. |
maxConcurrentChatsForAllAgents |
integer | Maximum number of chats for all agents. |
ifAgentCanManuallyAcceptChatsAfterReachingMaxChatsLimit |
bool | Whether to allow agent to manually accept chat after reaching max chats limit in agent console. |
ifNotAutoDistributeChatsToAgentsWhenHavingAudioVideoChat |
bool | Whether to allocate chats to agents who are having audio or video chats. |
isLastChattedAgentPreferredForAutoAccept |
bool | Whether the last-chatted agent is preferred or not. |
agentAutoDistributionConfigs |
agentAutoDistributionConfigs[] | Reference to Agent Auto Distribution. |
departmentAutoDistributionConfigs |
departmentAutoDistributionConfigs[] | Reference to Department Auto Distribution. |
Agent Auto Distribution JSON Format:
| Name | Type | Description |
|---|---|---|
ifAutoAcceptChat |
bool | When it is false, the agent will not accept chat automatically. Default: true. |
maxConcurrentChats |
integer | Maximum chat number. |
agentId |
guid | Id of the agent. |
agent |
agent | Reference to Agent. |
Department Auto Distribution JSON Format:
| Name | Type | Description |
|---|---|---|
departmentId |
guid | Id of the department. |
autoDistributionMethod |
string | Allowed values are "loadBalancing", "roundRobin", "capabilityWeighted". |
isLastChattedAgentPreferred |
bool | Whether the last chatted agent is preferred or not. |
backupDepartmentId |
guid | Id of the backup department. |
Endpoint
Get a single Auto Distribution
GET livechat/autoDistributionConfig
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
include |
string | query | no | Allowed values are "agentAutoDistributionConfig", "departmentAutoDistributionConfig". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/autoDistributionConfig \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Disable the Auto Distribution
POST livechat/autoDistributionConfig:disable
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/autoDistributionConfig:disable \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Enable the Auto Distribution
POST livechat/autoDistributionConfig:enable
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/autoDistributionConfig:enable \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Update the Auto Distribution
PUT livechat/autoDistributionConfig
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
isEnabled |
bool | body | no | Whether auto distribution is enabled or not. |
autoDistributionMethod |
string | body | no | Allowed values are "loadBalancing", "roundRobin", "capabilityWeighted". |
isLastChattedAgentPreferredForAutoDistribution |
bool | body | no | Whether the last-chatted agent is preferred or not. |
ifLimitMaxConcurrentChatsForAllAgents |
bool | body | no | Whether to set the same maximum number of chats for all agents. |
maxConcurrentChatsForAllAgents |
integer | body | no | Maximum number of chats for all agents. |
ifAgentCanManuallyAcceptChatsAfterReachingMaxChatsLimit |
bool | body | no | Whether to allow agent to manually accept chat after reaching max chats limit in agent console. |
ifNotAutoDistributeChatsToAgentsWhenHavingAudioVideoChat |
bool | body | no | Whether to allocate chats to agents who are having audio or video chats. |
isLastChattedAgentPreferredForAutoAccept |
bool | body | no | Whether the last-chatted agent is preferred or not. |
agentAutoDistributionConfigs |
agentAutoDistributionConfigs[] | body | no | Reference to Agent Auto Distribution. |
departmentAutoDistributionConfigs |
departmentAutoDistributionConfigs[] | body | no | Reference to Department Auto Distribution. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/autoDistributionConfig \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"isEnabled":true,"autoDistributionMethod":"loadBalancing","isLastChattedAgentPreferredForAutoDistribution":true,"ifLimitMaxConcurrentChatsForAllAgents":true,"maxConcurrentChatsForAllAgents":3,"ifAgentCanManuallyAcceptChatsAfterReachingMaxChatsLimit":true,"ifNotAutoDistributeChatsToAgentsWhenHavingAudioVideoChat":true,"isLastChattedAgentPreferredForAutoAccept":true,"agentAutoDistributionConfigs":[{"ifAutoAcceptChat":true,"maxConcurrentChats":3}],"departmentAutoDistributionConfigs":[{"autoDistributionMethod":"0","isLastChattedAgentPreferred":true,"backupDepartmentId":"DE314FF0-E864-4929-81E7-7E575F752037"}]}'
Response:
HTTP/1.1 200 OK