UserServicePresence

Represents a presence user’s real-time presence status. This object is available in API version 32.0 and later.

Supported Calls

delete(), query(), getDeleted(), getUpdated(), retrieve(), undelete()

To access this object, Omni-Channel must be enabled.

Field	Details
ConfiguredCapacity	Type int Properties Filter, Group, Nillable, Sort Description The user’s total configured capacity.
IsAway	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user’s status is `Away`.
Name	Type string Properties Create, Filter, Nillable, Sort, Update Description An automatically generated ID number that identifies the record.
OwnerId	Type reference Properties Filter, Group, Sort Description The ID of the owner of the UserServicePresence entity. For external routing, allows the entity to be used in the Streaming API to listen to events whenever a UserServicePresence record is created, modified, or deleted.
ServicePresenceStatusId	Type reference Properties Create, Filter, Nillable, Sort, Update Description The ID of the presence status that’s associated with the presence user that’s specified by the UserId.
UserId	Type string Properties Create, Filter, Group, Sort, Update Description The ID of the Omni-Channel user.

Apex triggers aren’t supported with UserServicePresence.

Sharing rules aren’t supported with UserServicePresence even if the OwnerId field is enabled.

In API version 41.0 or later, UserServicePresence records can be deleted programmatically. The “Customize Application” permission is required.

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

UserServicePresenceOwnerSharingRule: Sharing rules are available for the object.
UserServicePresenceShare: Sharing is available for the object.