Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
EmbeddedServiceLiveAgent
Represents a setup node for creating an
embedded chat deployment. This type extends the Metadata metadata type and inherits its
fullName field.
File Suffix and Directory Location
EmbeddedServiceLiveAgent components are stored in the developer_name.EmbeddedServiceLiveAgent file in the EmbeddedServiceLiveAgent folder.
Version
EmbeddedServiceLiveAgent is available in API version 38.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| avatarImg | string | Avatar image for this embedded chat deployment. |
| customPrechatComponent | string | The custom Lightning Component that’s used for the pre-chat page in this embedded chat deployment. |
| embeddedServiceConfig | string | Required. The name of the embedded service configuration node. |
| embeddedServiceQuickActions | EmbeddedServiceQuickAction | The quick action used by the pre-chat form. |
| enabled | boolean | Required. Indicates whether this embedded chat deployment is enabled (true). |
| fontSize | EmbeddedServiceFontSize (enumeration of type string) | Required. The font size for the text in the embedded chat window. One of the
following values:
|
| headerBackgroundImg | string | Header background image for this embedded chat window. Removed in API version 49.0. |
| isOfflineCaseEnabled | boolean | Indicates whether offline support is enabled for this embedded chat deployment. Available in API version 43.0 and later. |
| isQueuePositionEnabled | boolean | Indicates whether queue position (displaying the chat visitor’s place in line while they wait for an agent) is enabled for this embedded chat deployment. Available in API version 43.0 and later. |
| liveAgentChatUrl | string | The rest endpoint for chats. |
| liveAgentContentUrl | string | The rest endpoint for cChat content. |
| liveChatButton | string | Required. Reference to a chat button created in Chat setup. |
| liveChatDeployment | string | Required. Reference to a deployment created in Chat setup. |
| masterLabel | string | Required. Name of the embedded chat deployment. |
| offlineCaseBackgroundImg | string | Offline support case form background image for this embedded chat window. Available in API version 43.0 and later. |
| prechatBackgroundImg | string | Pre-chat background image for this embedded chat window. |
| prechatEnabled | string | Required. Indicates whether the embedded chat pre-chat form is enabled for this deployment. |
| prechatJson | string | JSON object of all the fields of the selected pre-chat form in Chat setup. |
| scenario | EmbeddedServiceScenario (enumeration of type string) | Required. The scenario for the embedded chat window that determines which
objects to relate to the chat. One of the following values:
|
| smallCompanyLogoImg | string | Company logo image for this embedded chat window. |
| waitingStateBackgroundImg | string | Chat waiting image for this embedded chat window. |
EmbeddedServiceQuickAction
Returns a quick action that’s associated with an EmbeddedServiceLiveAgent setup. The quick action includes the pre-chat form fields that the embedded chat window displays and shows the order in which the fields are displayed.
| Field Name | Field Type | Description |
|---|---|---|
| embeddedServiceLiveAgent | string | Reference to the embedded chat deployment. |
| order | int | Order in which this quick action appears in the embedded chat pre-chat form. |
| quickActionDefinition | string | Reference to a quick action. |
| quickActionType | EmbeddedServiceQuickActionType (enumeration of type string) | Quick action type. One of the following values:
|
Declarative Metadata Sample Definition
The following is an example of an EmbeddedServiceLiveAgent file.
<?xml version="1.0" encoding="UTF-8"?>
<EmbeddedServiceLiveAgent xmlns="http://soap.sforce.com/2006/04/metadata">
<avatarImg>https://google.com/avatar.png</avatarImg>
<customPrechatComponent>auraCustomPrechat</customPrechatComponent>
<embeddedServiceConfig>EswConfig001</embeddedServiceConfig>
<embeddedServiceQuickActions>
<embeddedServiceLiveAgent>EmbeddedServiceLiveAgent_Parent04Ixx0000000001EAA_15ec5bd2971</embeddedServiceLiveAgent>
<order>1</order>
<quickActionDefinition>Snapins_Contact_QuickAction_08hRM000000001h</quickActionDefinition>
</embeddedServiceQuickActions>
<embeddedServiceQuickActions>
<embeddedServiceLiveAgent>EmbeddedServiceLiveAgent_Parent04Ixx0000000001EAA_15ec5bd2971</embeddedServiceLiveAgent>
<order>1</order>
<quickActionDefinition>Snapins_Case_OfflineCaseQuickAction_08hRM000000001h</quickActionDefinition>
<quickActionType>OfflineCase</quickActionType>
</embeddedServiceQuickActions>
<embeddedServiceQuickActions>
<embeddedServiceLiveAgent>EmbeddedServiceLiveAgent_Parent04Ixx0000000001EAA_15ec5bd2971</embeddedServiceLiveAgent>
<order>2</order>
<quickActionDefinition>Snapins_Case_QuickAction_08hRM000000001h</quickActionDefinition>
</embeddedServiceQuickActions>
<enabled>true</enabled>
<fontSize>Medium</fontSize>
<headerBackgroundImg>https://google.com/headerBackgroundImg.png</headerBackgroundIm>
<isOfflineCaseEnabled>true</isOfflineCaseEnabled>
<isQueuePositionEnabled>true</isQueuePositionEnabled>
<liveChatButton>chatButton01</liveChatButton>
<liveChatDeployment>liveAgentDeployment01</liveChatDeployment>
<masterLabel>EmbeddedServiceLiveAgent_Parent04Ixx0000000001EAA_15ec5bd2971</masterLabel>
<offlineCaseBackgroundImg>https://google.com/offlineCaseBackgroundImg.png</offlineCaseBackgroundImg>
<prechatBackgroundImg>https://google.com/prechatBackgroundImg.png</prechatBackgroundImg>
<prechatEnabled>true</prechatEnabled>
<scenario>Service</scenario>
<smallCompanyLogoImg>https://google.com/smallCompanyLogoImg.png</smallCompanyLogoImg>
<waitingStateBackgroundImg>https://google.com/waitingImage.png</waitingStateBackgroundImg>
</EmbeddedServiceLiveAgent>Usage
EmbeddedServiceLiveAgent represents a Chat configuration that is added to your web page. The EmbeddedServiceLiveAgent record contains a unique combination of a chat button and the Chat deployment that the administrator selects during setup.
To create an EmbeddedServiceLiveAgent record:
- Create a Chat Deployment record.
- Create a Chat Button record.
- Create an EmbeddedServiceConfig record.
- Set the fields for the Chat Deployment record, Chat Button record, and EmbeddedServiceConfig record as references on the EmbeddedServiceLiveAgent record.
Any changes you make to the image fields override what you’ve entered in Setup. We recommend setting your image URLs in Setup.
Wildcard Support in the Manifest File
This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.