UserServicePresence

Represents a presence user’s real-time presence status.

Introduced in API version 30.0.

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

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 34.0
  • Description: The duration that the user is at full capacity. This field is updated when the agent’s capacity changes, such as when the agent is assigned, declines, or closes a work item.
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 34.0
  • Description: The user’s average capacity. This field is updated when the agent’s capacity changes, such as when the agent is assigned, declines, or closes a work item.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 32.0
  • Description: The user’s total configured primary capacity.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 58.0
  • Description: The user’s total configured interruptible capacity. Available in version 57.0 and later when the Interruptible Capacity feature is enabled.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 34.0
  • Description: The duration that the user is idle. This field is updated when the agent’s capacity changes, such as when the agent is assigned, declines, or closes a work item.
  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 34.0

  • Description:

    Indicates whether the user’s status is Away.

    The default value is false.

  • Default value: false

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 34.0

  • Description:

    Indicates whether a presence status is the user’s current state. If true, the agent is in that presence status.

    The default value is false.

  • Default value: false

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 58.0

  • Default value: false

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: An automatically generated ID number that identifies the record.
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort, Update
  • Description: The ID of the presence status that’s associated with the presence user that’s specified by the UserId.
  • Relationship name: ServicePresenceStatus
  • Relationship type: relationship
  • Refers to: ServicePresenceStatus
  • Type: int

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 34.0

  • Description:

    The duration of the user service presence status. This field is set only when the current user service presence status ends, such as when the agent changes to another presence status or logs out.

    This field is a calculated field: StatusEndDate - StatusStartDate.

  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 34.0
  • Description: The end date of the user service presence status. This field is set only when the current user service presence status ends, such as when the agent changes to another presence status or logs out.
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 34.0
  • Description: The start date of the user service presence status.
  • Type: reference
  • Properties: Filter, Group, Sort
  • Description: The ID of the Omni-Channel user.
  • Relationship name: User
  • Relationship type: relationship
  • Refers to: User

Apex triggers aren’t supported with UserServicePresence.

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. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.