---
schema_version: "1"
id: b830461e3719086336554b03d64511d02353ad23988f48a459cbb03be5b8d8a4
title: LiveChatAgentConfig
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_livechatagentconfig.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_livechatagentconfig.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: b4b9c2d905c9cd1cfbfbb4ca9a1e2592de5bbd388758fd4ac2a4bb6a7a069df6
description: Represents the configuration of an organization’s Chat deployment, such as how many chats can be assigned to an agent and whether chat sounds are enabled.
---
# LiveChatAgentConfig

Represents the configuration of an organization’s Chat deployment, such as how many chats can be assigned to an agent and whether chat sounds are enabled.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

LiveChatAgentConfig configurations are referenced in the <developer\_name>.liveChatAgentConfig file in the liveChatAgentConfigs directory.

## Version

LiveChatAgentConfig is available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d635042e99">Field Name</th>

              <th class="featureTableHeader  " id="d635042e102">Field Type</th>

              <th class="featureTableHeader  " id="d635042e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">assignments</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type"><a class="xref" href="#agentconfigassignments">AgentConfigAssignments</a></td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies how agent configurations are assigned to Chat users.
                Agent configurations can be assigned to sets of users or sets of
                profiles.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">autoGreeting</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the greeting that displays when a customer begins a
                chat with an agent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">capacity</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">int</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the maximum number of chats in which an agent can be
                engaged at a time.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="CriticalWaitTime-FA139B64"><a name="CriticalWaitTime-FA139B64"><!-- --></a>criticalWaitTime</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">int</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the number of seconds an agent can wait to answer an
                engaged chat before the chat tab flashes to alert the agent to
                answer it.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="CustomAgentName"><a name="CustomAgentName"><!-- --></a>customAgentName</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the custom name for an agent, if one has been set.
                Available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">disableTransferConferenceGreeting</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether the greeting is disabled for agents during chat
                transfer and chat conferencing (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 53.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableAgentFileTransfer</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether file transfer is enabled for agents (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 31.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="enableAgentSneakPeek"><a name="enableAgentSneakPeek"><!-- --></a>enableAgentSneakPeek</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies whether a supervisor can see the content of an
                agent’s message before they send it to a customer (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableAssistanceFlag</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">
                <span class="ph" id="assistance_flag"><a name="assistance_flag"><!-- --></a>Indicates whether agents can raise an
                  assistance flag to notify a supervisor that they need help.</span>
                Available in API version 35.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableAutoAwayOnDecline</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether an agent appears as “away”
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) when an agent declines a chat
                with a customer.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableAutoAwayOnPushTimeout</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether an agent appears as “away”
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) when a chat request that's
                been pushed to the agent times out. Available in API version 34.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatConferencing</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether chat conferencing is enabled for agents
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 34.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatMonitoring</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether chat monitoring is enabled for support
                supervisors (<samp class="codeph java">true</samp>) or not
                (<samp class="codeph java">false</samp>). Available in API
                version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatTransferToAgent</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether agents can transfer a chat to another agent
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 36.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatTransferToButton</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether agents can transfer a chat to a button (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 36.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableChatTransferToSkill</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether agents can transfer a chat to a skill group
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 36.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableLogoutSound</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether a sound plays (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) when an agent logs out of Chat.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableNotifications</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether notifications of incoming chats appear for
                agents (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableRequestSound</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether a sound plays (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) when a customer requests to chat with an
                agent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableSneakPeek</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether previews of customers’ messages are
                displayed as customers type (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>) in
                the agent’s Chat window. Available in API version 29.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableVisitorBlocking</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether an agent can block a visitor by IP address
                (<samp class="codeph java">true</samp>) or not (<samp class="codeph java">false</samp>). Available in API version 34.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">enableWhisperMessage</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d635042e105" data-title="Description">Indicates whether support supervisors can send whisper messages
                to agents during a chat (<samp class="codeph java">true</samp>) or
                not (<samp class="codeph java">false</samp>). Available in API
                version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Required. Specifies the name of the configuration for
                agents’ default chat settings.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="SupervisorDefaultAgentStatusFilter-055C8ED2"><a name="SupervisorDefaultAgentStatusFilter-055C8ED2"><!-- --></a>supervisorDefaultAgentStatusFilter</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">SupervisorAgentStatusFilter (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the Chat status for filtering the Agent Status list in
                the Supervisor Panel. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph xml">Online</samp></li>

                  <li class="li"><samp class="codeph xml">Away</samp></li>

                  <li class="li"><samp class="codeph xml">Offline</samp></li>

                </ul>
                <p class="p">Available in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="SupervisorDefaultButtonFilter-055D186A"><a name="SupervisorDefaultButtonFilter-055D186A"><!-- --></a>supervisorDefaultButtonFilter</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the default button for filtering the Agent Status list
                in the Supervisor Panel. Available in API version 29.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="SupervisorDefaultSkillFilter-055D2022"><a name="SupervisorDefaultSkillFilter-055D2022"><!-- --></a>supervisorDefaultSkillFilter</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type">string</td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the default skill for filtering the Agent Status list
                in the Supervisor Panel. Available in API version 29.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname" id="SupervisorSkills-055D2784"><a name="SupervisorSkills-055D2784"><!-- --></a>supervisorSkills</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type"><a class="xref" href="#supervisoragentconfigskills">SupervisorAgentConfigSkills</a></td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the list of agent skills that are assigned to a
                supervisor, as specified in their assigned Chat configuration.
                Available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">transferableButtons</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type"><a class="xref" href="#agentconfigbuttons">AgentConfigButtons</a></td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the list of chat buttons that agents can transfer chats
                to. Available in API version 31.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d635042e99" data-title="Field Name"><span class="keyword parmname">transferableSkills</span></td>

              <td class="entry" headers="d635042e102" data-title="Field Type"><a class="xref" href="#agentconfigskills">AgentConfigSkills</a></td>

              <td class="entry" headers="d635042e105" data-title="Description">Specifies the list of skill groups that agents can transfer chats
                to. Available in API version 31.0 and later.</td>

            </tr>

          </tbody>

        </table>

## AgentConfigAssignments

Represents the assignments of an organization’s profiles and users to a Chat configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| profiles | [AgentConfigProfileAssignments](#agentconfigprofileassignments) | Specifies the profiles that are associated with a specific agent configuration. |
| users | [AgentConfigUserAssignments](#agentconfiguserassignments) | Specifies the users that are associated with a specific agent configuration. |

## AgentConfigButtons

Represents the chat buttons that agents who are associated with the Chat configuration can transfer chats to.

| Field Name | Field Type | Description |
| --- | --- | --- |
| button | string\[\] | Specifies the chat buttons that agents can transfer chats to. |

## AgentConfigProfileAssignments

Represents the profiles associated with a specific Chat configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| profile | string | Specifies the custom name of the profile associated with a specific agent configuration. |

## AgentConfigSkills

Represents the skill groups that agents who are associated with the Chat configuration can transfer chats to.

| Field Name | Field Type | Description |
| --- | --- | --- |
| skill | string\[\] | Specifies the skill groups that agents can transfer chats to. |

## AgentConfigUserAssignments

Represents the users associated with a specific Chat configuration.

| Field Name | Field Type | Description |
| --- | --- | --- |
| user | string | Specifies the username of the user associated with a specific agent configuration. |

## SupervisorAgentConfigSkills

Represents the agent skills associated with a supervisor’s Chat configuration. Available in API version 29.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| skill | string | Specifies the agent skills available for filtering the Agent Status list in the Supervisor Panel. |

## Declarative Metadata Sample Definition

This is a sample of a liveChatAgentConfig file.

<?xml version="1.0" encoding="UTF-8"?>
<LiveChatAgentConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>My Agent Configuration 1</label\>
    <autoGreeting\>Hi, how can I help you?</autoGreeting\>
    <capacity\>5</capacity\>
    <enableAutoAwayOnDecline\>true</enableAutoAwayOnDecline\>
    <enableLogoutSound\>true</enableLogoutSound\>
    <enableNotifications\>true</enableNotifications\>
    <enableRequestSound\>true</enableRequestSound\>
    <enableSneakPeek\>true</enableSneakPeek\>
    <enableWhisperMessage\>true</enableWhisperMessage\>
    <assignments\>
        <profiles\>
            <profile\>standard</profile\>
        </profiles\>
        <users\>
            <user\>jdoe@acme.com</user\>
        </users\>
    </assignments\>
</LiveChatAgentConfig\>

## Wildcard Support in the Manifest File

This metadata type supports 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).