| AutoGreeting |
- Type
- textarea
- Properties
- Create, Nillable, Update
- Description
- The text that is automatically sent from an agent to a visitor
when a chat session starts.
|
| Capacity |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Limits the number of active chat session an agent can engage in.
|
| CriticalWaitTime |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The amount of time before a chat flashes to alert an agent to
answer it.
|
| CustomAgentName |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The custom name of the agent associated with the Live Agent configuration.
|
| DeveloperName |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The unique name of the object in the API. This name can contain only
underscores and alphanumeric characters, and must be unique in your
organization. It must begin with a letter, not include spaces, not
end with an underscore, and not contain two consecutive underscores. In managed
packages, this field prevents naming conflicts on package installations. With this
field, a developer can change the object’s name in a managed package and the
changes are reflected in a subscriber’s organization.
When
creating large sets of data, always specify a unique DeveloperName
for each record. If no DeveloperName is specified, performance may
slow while Salesforce generates one for each record.
|
| HasCrmChatlet |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether the CRM chatlet appears in the agent console.
|
| HasDetailsChatlet |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether the Details chatlet appears in the agent console.
|
| HasHistoryChatlet |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether the History chatlet appears in the agent console.
|
| HasKnowledgeChatlet |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether the Knowledge chatlet appears in the agent
console.
|
| HasLivetrackChatlet |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether the Livetrack chatlet appears in the agent
console.
|
| HasLogoutSound |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether a sound plays when an agent logs out of the
console.
|
| HasMapChatlet |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether the Map chatlet appears in the agent console.
|
| HasNotifications |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether desktop notifications are enabled for the configuration.
Available in API version 25.0 and later.
|
| HasQueueChatlet |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether the Queue chatlet appears in the agent console.
|
| HasRequestSound |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether a sound plays when a chat request comes in.
|
| HasSneakPeek |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether an agent sees a real-time preview of the messages
a visitor types.
|
| IsAutoAwayOnDecline |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Determines whether agents’ status is automatically changed
to Away when they decline a chat request. Available in API version
26.0 and later.
|
| Language |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description
- The language of the configuration.
|
| MasterLabel |
- Type
- string
- Properties
- Create, Filter, Group, Sort, Update
- Description
- The name of the configuration.
|
| OptionsHasAgentSneakPeek |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Determines whether Sneak Peek is enabled for agents. Available
in API version 29.0 and later.
|
| OptionsHasChatMonitoring |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Determines whether supervisors can view agents’ ongoing
chats. Available in API version 29.0 and later.
|
| OptionsHasChatTransfer |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Determines whether an agent can transfer a chat to other agents.
Available in API version 31.0 and later.
|
| OptionsHasWhisperMessage |
- Type
- boolean
- Properties
- Create, Filter, Update
- Description
- Determines whether supervisors can send private messages to agents
within an agent’s chat with a customer. Available in API version
29.0 and later.
|
| SupervisorDefaultAgentStatus |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description
- The default agent status by which to filter agents in the Agent
Status list in the supervisor panel.
|
| SupervisorDefaultButtonId |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description
- The default button ID by which to filter agents in the Agent Status
list in the supervisor panel.
|
| SupervisorDefaultSkillId |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description
- The default skill ID by which to filter agents in the Agent Status
list in the supervisor panel.
|