Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

LiveAgentSession

This object is automatically created for each Live Agent session and stores information about the session. This object is available in API versions 28.0 and later.

Standard fields for the LiveAgentSession object can only be modified if your administrator has given you editing permissions for these records.

Note

Supported Calls

create(), delete(), describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(), undelete(), update()

Fields

Field Name Details
AgentId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the agent associated with the session.
ChatReqAssigned
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of chat requests that were assigned to an agent during a session.
ChatReqDeclined
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of chat requests that were declined by an agent during a session.
ChatReqEngaged
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of chats in which an agent was engaged during a session.
ChatReqTimedOut
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of chat requests that timed out in an agent’s queue during a session.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time that the session record was last referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time that the session record was last viewed.
LoginTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time an agent logged in during the session.
LogoutTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time an agent logged out during a session.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookupSort
Description
The name of the session.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the owner of the session record.
TimeAtCapacity
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The amount of time an agent spent with the maximum number of chats in his or her queue.
TimeIdle
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The amount of time an agent spent idle during the session.
TimeInAwayStatus
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The amount of time an agent spent with a status of “Away” during a session.
TimeInChats
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The amount of time an agent spent engaged in chats during a session.
TimeInOnlineStatus
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The amount of time an agent spent with a status of “Online” during a session.

Usage

Use this object to query and manage live chat session records.