LiveChatAgentConfig | メタデータ API 開発者ガイド

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

LiveChatAgentConfig 設定は、liveChatAgentConfigs ディレクトリの <developer_name>.liveChatAgentConfig ファイルで参照されます。

バージョン

LiveChatAgentConfig は、API バージョン 28.0 以降で使用できます。

項目

項目名	項目の型	説明
assignments	AgentConfigAssignments	チャットユーザーへのエージェント設定の割り当て方法を指定します。エージェント設定は、ユーザーのセットまたはプロファイルのセットに割り当てることができます。
autoGreeting	string	エージェントとのチャットの開始時に顧客に表示される挨拶を指定します。
capacity	int	エージェントが一度に参��できるチャットの最大数を指定します。
criticalWaitTime	int	チャットタブが点滅して、参加しているチャットに回答するように注意が促されるまでに、エージェントが回答するまでに待機できる秒数を指定します。
customAgentName	string	エージェントのカスタム名を指定します (設定されている場合)。API バージョン 29.0 以降で利用できます。
disableTransferConferenceGreeting	boolean	チャット転送およびチャット会議中にエージェントの挨拶を無効化するか (`true`)、否か (`false`) を示します。API バージョン 53.0 以降で利用できます。
enableAgentFileTransfer	boolean	エージェントのファイル転送が有効か (`true`)、否か (`false`) を示します。API バージョン 31.0 以降で利用できます。
enableAgentSneakPeek	boolean	エージェントがメッセージを顧客に送信する前にスーパーバイザーがその内容を確認できるか (`true`)、否か (`false`) を示します。
enableAssistanceFlag	boolean	エージェントが支援フラグを有効にして、支援が必要なことをスーパーバイザーに知らせることができるかどうかを示します。API バージョン 35.0 以降で利用できます。
enableAutoAwayOnDecline	boolean	エージェントが顧客とのチャットに参加しないときに、エージェントを「退席中」として表示するか (`true`)、否か (`false`) を示します。
enableAutoAwayOnPushTimeout	boolean	エージェントに転送されたチャット要求がタイムアウトしたときに、エージェントを「退席中」として表示するか (`true`)、否か (`false`) を示します。API バージョン 34.0 以降で利用できます。
enableChatConferencing	boolean	エージェントのチャット会議が有効か (`true`)、否か (`false`) を示します。API バージョン 34.0 以降で利用できます。
enableChatMonitoring	boolean	サポートスーパーバイザーのチャット監視が有効になっているか (`true`)、否か (`false`) を示します。API バージョン 29.0 以降で利用できます。
enableChatTransferToAgent	boolean	エージェントがチャットを他のエージェントに転送できるか (`true`)、否か (`false`) を示します。API バージョン 36.0 以降で利用できます。
enableChatTransferToButton	boolean	エージェントがチャットをボタンに転送できるか (`true`)、否か (`false`) を示します。API バージョン 36.0 以降で利用できます。
enableChatTransferToSkill	boolean	エージェントがチャットをスキルグループに転送できるか (`true`)、否か (`false`) を示します。API バージョン 36.0 以降で利用できます。
enableLogoutSound	boolean	エージェントがチャットからログアウトするときに、音を鳴らすか (`true`)、否か (`false`) を示します。
enableNotifications	boolean	受信チャット通知をエージェントに表示するか (`true`)、否か (`false`) を示します。
enableRequestSound	boolean	顧客がエージェントとのチャットを要求するときに、音を鳴らすか (`true`)、否か (`false`) を示します。
enableSneakPeek	boolean	顧客のメッセージのプレビューをエージェントのチャットウィンドウに顧客タイプとして表示するか (`true`)、否か (`false`) を示します。API バージョン 29.0 以降で利用できます。
enableVisitorBlocking	boolean	エージェントが IP アドレスで訪問者をブロックできるか (`true`)、否か (`false`) を示します。API バージョン 34.0 以降で利用できます。
enableWhisperMessage	boolean	サポートスーパーバイザーがチャット中に示唆メッセージをエージェントに送信できるか (`true`)、否か (`false`) を示します。API バージョン 29.0 以降で利用できます。
label	string	必須。エージェントのデフォルトのチャット設定の名前を指定します。
supervisorDefaultAgentStatusFilter	SupervisorAgentStatusFilter (string 型の列挙)	スーパーバイザーパネルの [エージェント状況] リストを絞り込むためのチャットの状況を指定します。有効な値は、次のとおりです。 `Online` `Away` `Offline` API バージョン 29.0 以降で利用できます。
supervisorDefaultButtonFilter	string	スーパーバイザーパネルの [エージェント状況] リストを絞り込むためのデフォルトのボタンを指定します。API バージョン 29.0 以降で利用できます。
supervisorDefaultSkillFilter	string	スーパーバイザーパネルの [エージェント状況] リストを絞り込むためのデフォルトのスキルを指定します。API バージョン 29.0 以降で利用できます。
supervisorSkills	SupervisorAgentConfigSkills	割り当て済みのチャット設定で指定されたとおりに、スーパーバイザーに割り当てられるエージェントスキルを指定します。API バージョン 29.0 以降で利用できます。
transferableButtons	AgentConfigButtons	エージェントがチャットの転送先にできるチャットボタンのリストを指定します。API バージョン 31.0 以降で利用できます。
transferableSkills	AgentConfigSkills	エージェントがチャットの転送先にできるスキルグループのリストを指定します。API バージョン 31.0 以降で利用できます。

AgentConfigAssignments

組織のプロファイルとユーザーのチャット設定への割り当てを表します。

項目名	項目の型	説明
profiles	AgentConfigProfileAssignments	特定のエージェント設定に関連付けられたプロファイルを指定します。
users	AgentConfigUserAssignments	特定のエージェント設定に関連付けられたユーザーを指定します。

AgentConfigButtons

チャット設定に関連付けられているエージェントが、チャットの転送先にできるチャットボタンを表します。

項目名	項目の型	説明
button	string[]	エージェントがチャットの転送先にできるチャットボタンを指定します。

AgentConfigProfileAssignments

特定のチャット設定に関連付けられたプロファイルを表します。

項目名	項目の型	説明
profile	string	特定のエージェント設定に関連付けられたプロファイルのカスタム名を指定します。

AgentConfigSkills

チャット設定に関連付けられているエージェントが、チャットの転送先にできるスキルグループを表します。

項目名	項目の型	説明
skill	string[]	エージェントがチャットの転送先にできるスキルグループを指定します。

AgentConfigUserAssignments

特定のチャット設定に関連付けられたユーザーを表します。

項目名	項目の型	説明
user	string	特定のエージェント設定に関連付けられたユーザーのユーザー名を指定します。

SupervisorAgentConfigSkills

スーパーバイザーのチャット設定に関連付けられたエージェントスキルを表します。API バージョン 29.0 以降で利用できます。

項目名	項目の型	説明
skill	string	スーパーバイザーパネルの [エージェント状況] リストを絞り込むことができるエージェントスキルを指定します。

宣言的なメタデータの定義のサンプル

これは、liveChatAgentConfig ファイルのサンプルです。

1<?xml version="1.0" encoding="UTF-8"?>
2<LiveChatAgentConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>My Agent Configuration 1</label>
4    <autoGreeting>Hi, how can I help you?</autoGreeting>
5    <capacity>5</capacity>
6    <enableAutoAwayOnDecline>true</enableAutoAwayOnDecline>
7    <enableLogoutSound>true</enableLogoutSound>
8    <enableNotifications>true</enableNotifications>
9    <enableRequestSound>true</enableRequestSound>
10    <enableSneakPeek>true</enableSneakPeek>
11    <enableWhisperMessage>true</enableWhisperMessage>
12    <assignments>
13        <profiles>
14            <profile>standard</profile>
15        </profiles>
16        <users>
17            <user>jdoe@acme.com</user>
18        </users>
19    </assignments>
20</LiveChatAgentConfig>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。