Salesforce Console Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
getAgentWorkload
In API version 35.0 and later, we can retrieve an agent’s currently assigned
workload. Use this method for rerouting work to available agents.
Syntax
sforce.console.presence.getAgentWorkload(callback:function)Arguments
| Name | Type | Description |
|---|---|---|
| callback | function | JavaScript method to call when the agent’s configured capacity and work is retrieved. |
Sample Code–Visualforce
<apex:page>
<apex:includeScript value="/support/console/63.0/integration.js"/>
<a href="#" onClick="testGetAgentWorkload();return false;">
Get Agent’s configured capacity and current workload
</a>
<script type="text/javascript">
function testGetAgentWorkload() {
sforce.console.presence.getAgentWorkload(function(result) {
if (result.success) {
alert('Retrieved Agent Configured Capacity and Current Workload successfully');
alert('Agent\'s configured capacity is: ' + result.configuredCapacity);
alert('Agent\'s currently assigned workload is: ' + result.currentWorkload);
} else {
alert('Get Agent Workload failed');
}
});
}
</script>
</apex:page>Response
This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:
| Name | Type | Description |
|---|---|---|
| success | Boolean | true if retrieving the agent’s work items was successful; false if retrieving the agent’s work items wasn’t successful. |
| configuredCapacity | Number | Indicates the agent’s configured primary capacity (work that’s assigned to the current user) through Presence Configuration. |
| currentWorkload | Number | Indicates the agent’s currently assigned primary workload. |
| configuredInterruptibleCapacity | Number | Indicates the agent’s configured interruptible capacity (work that’s assigned to the current user) through Presence Configuration. |
| currentInterruptibleWorkload | Number | Indicates the agent’s currently assigned interruptible workload. |