LiveChatButton

Represents a button that allows visitors to request chats with Chat users. This object is available in API version 24.0 and later.

Supported Calls

create(), query(), update(), retrieve()

Fields

Field Name	Details
Animation	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of animation used when an automated chat invitation appears on-screen. For automated chat invitations only. Available in API version 29.0 and later.
AutoGreeting	Type textarea Properties Create, Filter, Nillable, Sort Description The text that is automatically sent from an agent to a visitor when a chat session starts. A greeting message in the AutoGreeting field of the LiveChatButton object overrides individual users’ greeting messages in the AutoGreeting field in the LiveChatUserConfig object. Note
ChasitorIdleTimeout	Type int Properties Create, Filter, Group, Nillable, Sort Description The amount of time a customer has to respond to an agent message before the chat times out.
ChasitorIdleTimeoutWarning	Type int Properties Create, Filter, Group, Nillable, Sort Description The amount of time a customer has to respond to an agent message before a warning appears and a timer begins a countdown. This value must be shorter than the ChasitorIdleTimeout value (we recommend at least 30 seconds shorter).
ChatPageId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the custom Visualforce page that contains the custom chat window code.
CustomAgentName	Type string Properties Create, Filter, Group, Nillable, Sort Description The custom name of the agent associated with the button. Available in API version 29.0 and later. A custom agent name in the CustomAgentName field of the LiveChatButton object overrides individual users’ custom agent name in the CustomAgentName field in the LiveChatUserConfig object. Note
DeveloperName	Type string Properties Create, Filter, Group, Sort 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 org. 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. Note
HasQueue	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Determines whether to allow incoming chat requests to queue until an agent is available.
InviteEndPosition	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The position on-screen where an automated chat invitation’s animation ends. You don’t need to select an end position for your automated chat invitation if you use a custom animation. Note For automated chat invitations only. Available in API version 29.0 and later.
InviteImageId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the static image resource displayed on your automated chat invitation. For automated chat invitations only. Available in API version 29.0 and later.
InviteStartPosition	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The position on-screen where an automated chat invitation’s animation begins. You don’t need to select a start position for your automated chat invitation if you use a custom animation. Note For automated chat invitations only. Available in API version 29.0 and later.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description For automated chat invitations, specifies whether an automated chat invitation is active and able to be sent to customers (`true`) or not (`false`). For chat buttons, this is set to `true` by default.
Language	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the chat.
MasterLabel	Type string Properties Create, Filter, Group, Sort Description Label for the chat button.
NumberOfReroutingAttempts	Type int Properties Create, Filter, Group, Nillable, Sort Description Specifies the number of times a chat request can be rerouted to available agents if all agents reject the chat request.
OfflineImageId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the static image resource that is displayed when the button is offline (inactive).
OnlineImageId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the static image resource that is displayed when the button is online (active).
OptionsHasChasitorIdleTimeout	Type boolean Properties Create, Filter Description Specifies whether Customer Time-Out is enabled.
OptionsHasInviteAfterAccept	Type boolean Properties Create, Filter Description Specifies whether an automated chat invitation can be sent to a customer after that customer has accepted a prior automated chat invitation (`true`) or not (`false`). For automated chat invitations only. Available in API version 29.0 and later.
OptionsHasInviteAfterReject	Type boolean Properties Create, Filter Description Specifies whether an automated chat invitation can be sent to a customer after that customer has rejected a prior automated chat invitation (`true`) or not (`false`). For automated chat invitations only. Available in API version 29.0 and later.
OptionsHasRerouteDeclinedRequest	Type boolean Properties Create, Filter Description Specifies whether a chat request that has been rejected by all available agents should be rerouted to available agents again (`true`) or not `false`).
OptionsIsAutoAccept	Type boolean Properties Create, Filter Description Specifies whether a chat request should be automatically accepted by the agent it’s assigned to (`true`) or not `false`). For chat buttons and automated chat invitations with RoutingType set to Most Available or Least Active. Available in API version 30.0 and later.
OptionsIsInviteAutoRemove	Type boolean Properties Create, Filter Description Specifies whether an automated chat invitation should be automatically removed from the screen after a certain amount of time (`true`) or not (`false`). For automated chat invitations only. Available in API version 29.0 and later.
OverallQueueLength	Type int Properties Create, Filter, Group, Nillable, Sort Description The maximum number of chat requests allowed to queue.
PerAgentQueueLength	Type int Properties Create, Filter, Group, Nillable, Sort Description The maximum number of chat requests allowed to queue for each agent with the required skill.
PostchatPageId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the custom Visualforce page displayed when the chat ends.
PostchatUrl	Type string Properties Create, Filter, Group, Nillable, Sort Description The URL the user is directed to after the chat ends.
PrechatFormPageId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the custom Visualforce page displayed before the chat begins.
PrechatFormUrl	Type string Properties Create, Filter, Group, Nillable, Sort Description The URL the user is directed to before the chat begins.
PushTimeout	Type int Properties Create, Filter, Group, Nillable, Sort Description The number of seconds an agent has to answer a chat request before it’s routed to the next available agent.
QueueId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the queue used for this chat button.
RoutingConfigurationId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the routing configuration used for this chat button.
RoutingType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description How chat requests are routed to agents. The values are: `Choice`—Incoming chat requests are added to the queue in Live Agent in the Salesforce console and are available to any agent with the required skill. `Least Active`—Incoming chats are routed to the agent with the required skill who has the fewest active chats. `Most Available`—Incoming chats are routed to the agent with the required skill and the greatest difference between chat capacity and active chat sessions. For example, if Agent A and Agent B each have a chat capacity of five, and Agent A has three active chat sessions while Agent B has one, incoming chats will be routed to Agent B. `Omni`—Incoming chats are routed using Omni-Channel queues.
SiteId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the site used for loading static resources and custom Visualforce pages.
SkillId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The record ID of the skill used to route incoming chat requests. To associate multiple skills with a chat button, reference one skill in the SkillId field and use LiveChatButtonSkill junction objects for the remaining skills.
TimeToRemoveInvite	Type int Properties Create, Filter, Group, Nillable, Sort Description The number of seconds an automated invitation stays on-screen before it is automatically removed. For automated chat invitations only. Available in API version 29.0 and later.
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of element to display to customers (either a chat button or an automated invitation).
WindowLanguage	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language used for standard chat windows. Custom chat windows use the language of the user’s browser.

Usage

Use this object to query and manage chat buttons and automated chat invitations.

Object Reference for Salesforce and Lightning Platform

LiveChatButton

Supported Calls

Fields

Usage