Set Up Omni-Channel Developer Guide
Winter '27 preview (API version 68.0)
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)
Omni-Channel Metadata API Types
acceptAgentWork for Lightning Experience
closeAgentWork for Lightning Experience
declineAgentWork for Lightning Experience
getAgentWorks for Lightning Experience
getAgentWorkload for Lightning Experience
getServicePresenceStatusChannels for Lightning Experience
getServicePresenceStatusId for Lightning Experience
login for Lightning Experience
logout for Lightning Experience
lowerAgentWorkFlag for Lightning Experience
raiseAgentWorkFlag for Lightning Experience
setServicePresenceStatus for Lightning Experience
Newer Version Available
Omni-Channel Objects for the Lightning Console JavaScript API
Omni-Channel lets your call center route any type of incoming work item to the most
qualified, available agents. The Lightning Console JavaScript API for Lightning Experience
includes several objects that let you control how Omni-Channel works within the Lightning
Service Console for your organization.
If you need more information on the Lightning Console JavaScript API, see Lightning Console JavaScript API.
-
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 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 to reroute 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 in to Omni-Channel with a specific presence status. -
logout for Lightning Experience
Logs an agent out of Omni-Channel. -
lowerAgentWorkFlag for Lightning Experience
Lowers a flag for this agent work item. -
raiseAgentWorkFlag for Lightning Experience
Raises a flag for this agent work item. -
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 in the agent with the presence status. This method removes the need for you to make more calls. -
Events for Omni-Channel
JavaScript can be executed when certain types of events occur in a console, such as when a user closes a tab. There are a few events that are specific to Omni-Channel. These events apply to Lightning Experience only.