Salesforce Console Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Summer '14 (API version 31.0)
Spring '14 (API version 30.0)
What Is the Console Developer Guide?
acceptAgentWork()
closeAgentWork()
declineAgentWork()
getAgentWorks()
getAgentWorkload()
getServicePresenceStatusChannels()
getServicePresenceStatusId()
login()
logout()
setServicePresenceStatus()
Newer Version Available
Methods for Omni-Channel in Lightning Experience (Beta)
Omni-Channel lets your call center route any type of incoming work item to the most
qualified, available agents.
This release contains a beta version of Omni-Channel Methods for the Lightning Console JavaScript API, which means it’s a high-quality feature with known limitations. The methods aren’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Note
For more information about Omni-Channel, see Omni-Channel for Administrators in Salesforce Help.
-
acceptAgentWork for Lightning Experience
Accepts a work item that’s assigned to an agent. -
closeAgentWork for Lightning Experience
Changes the status of a work item to “Closed” and removes it from the list of work items in the Omni-Channel utility. -
declineAgentWork for Lightning Experience
Declines a work item that’s assigned to an agent. -
getAgentWorks for Lightning Experience
Returns a list of work items that are currently assigned to an agent and open in the agent’s workspace. -
getAgentWorkload for Lightning Experience
Retrieves an agent’s currently assigned workload. Use this method for rerouting work to available agents. -
getServicePresenceStatusChannels for Lightning Experience
Retrieves the service channels that are associated with an Omni-Channel user’s current presence status. -
getServicePresenceStatusId for Lightning Experience
Retrieves an agent’s current presence status. -
login for Lightning Experience
Logs an agent into Omni-Channel with a specific presence status. -
logout for Lightning Experience
Logs an agent out of Omni-Channel. -
setServicePresenceStatus for Lightning Experience
Sets an agent's presence status to a status with a particular ID. If the specified agent is not already logged in, we log the agent into presence. This removes the need for you to make additional calls.