メタデータ API 開発者ガイド
jLiveChatButton
ボタンの表示ラベルやライブチャットの開始前に表示されるチャット前フォームなど、エージェントとチャットするために顧客がクリックするボタンやチャットウィンドウの Live Agent リリースの設定を表します。Metadata メタデータ型���拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
LiveChatButton 設定は、liveChatButtons ディレクトリの <developer_name>.liveChatButton ファイルに保存されます。
バージョン
LiveChatButton は、API バージョン 28.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| chasitorIdleTimeout | int | チャットがタイムアウトになるまでのアイドル時間を指定します。アイドル時間は、エージェントが最後のチャットメッセージを送信した後で開始します。API バージョン 35.0 以降で利用できます。 |
| chasitorIdleTimeoutWarning | int | 警告が表示されるまでのアイドル時間を指定します。アイドル時間は、エージェントが最後のチャットメッセージを送信した後で開始します。API バージョン 35.0 以降で利用できます。 |
| chatPage | string | ページが Live Agent チャットウィンドウと異なる場合に、チャットをホストするページを指定します。 |
| enableQueue | boolean | キューが有効化されているか (true)、否か (false) を示します。 |
| label | string | ボタンに表示するテキストを指定します。 |
| numberOfReroutingAttempts | int | すべてのエージェントがチャット要求を拒否した場合に、対応可能なエージェントにチャット要求を再転送できる回数を指定します。API バージョン 30.0 以降で利用できます。 |
| offlineImage | string | エージェントがチャットに対応できない場合にボタンに表示する画像を指定します。 |
| onlineImage | string | エージェントがチャットに対応できる場合にボタンに表示する画像を指定します。 |
| optionsCustomRoutingIsEnabled | boolean | 受信チャット要求のカスタム転送が有効か (true)、否か (false) を示します。API バージョン 30.0 以降で利用できます。 |
| optionsHasChasitorIdleTimeout | boolean | 訪問者のアイドルタイムアウト機能が有効になっているかどうかを示します。API バージョン 35.0 以降で利用できます。 |
| optionsHasInviteAfterAccept | boolean | 顧客が以前のチャット招待を受諾した後に、新しいチャット招待をトリガするか (true)、否か (false) を示します。 |
| optionsHasInviteAfterReject | boolean | 顧客が以前のチャット招待を辞退した後に、新しいチャット招待をトリガするか (true)、否か (false) を示します。 |
| optionsHasRerouteDeclinedRequest | boolean | すべての対応可能なエージェントから拒否されたチャット要求を、対応可能なエージェントに再転送する必要があるか (true)、否か (false) を示します。API バージョン 30.0 以降で利用できます。 |
| optionsIsAutoAccept | boolean | チャット要求を割り当てられたエージェントが、チャット要求を自動的に受け入れる必要があるか (true)、否か (false) を示します。[[チャット] ボタンおよび自動招待] で、routingType が MostAvailable または LeastActive に設定されている場合。API バージョン 30.0 以降で利用できます。 |
| optionsIsInviteAutoRemove | boolean | 特定の時間が経過した後に、チャット招待が自動的に顧客の画面から消えるように設定するか (true)、否か (false) を示します。 |
| overallQueueLength | int | キューに許可されるチャット要求の最大数を指定します。 |
| perAgentQueueLength | int | 必要なスキルを持つエージェントに対してキューが許可されるチャット要求の最大数を指定します。 |
| postChatPage | string | チャットの終了時に顧客が転送されるチャット後フォームの名前を指定します。 |
| postChatUrl | string | チャットの終了時に顧客が転送されるチャット後フォームの URL を指定します。 |
| preChatFormPage | string | チャットの開始前に顧客が転送されるチャット前フォームの名前を指定します。 |
| preChatFormUrl | string | チャットの開始時に顧客が転送されるチャット前フォームの URL を指定します。 |
| pushTimeOut | int | チャット要求が別のエージェントに転送されるまでに、エージェントが受信チャット要求への回答に費やすことのできる秒数を指定します。 |
| routingType | LiveChatButtonRoutingType (string 型の列挙) | 顧客がボタンを押したときに受信チャットをエージェントに転送する方法を指定します。有効な値は、次のとおりです。
|
| site | string | カスタムチャットボタンの画像またはカスタムチャットページをホストする Force.com サイトを指定します。 |
| skills | LiveChatButtonSkills | ボタンに関連付けられたスキルを指定します。チャットするために顧客がボタンをクリックすると、そのスキルを持つエージェントに自動的に転送されます。 |
| windowLanguage | Language | ボタンに関連付けられたチャットウィンドウの言語設定を指定します。 |
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| skill | string | スキルの名前を指定します。 |
宣言的なメタデータの定義のサンプル
これは、liveChatButton ファイルのサンプルです。
1<?xml version="1.0" encoding="UTF-8"?>
2<LiveChatButton xmlns="http://soap.sforce.com/2006/04/metadata">
3 <label>My Button 1</label>
4 <chatPage>ChatterAnswersLogin</chatPage>
5 <enableQueue>true</enableQueue>
6 <offlineImage>MyOfflineButton</offlineImage>
7 <onlineImage>MyOnlineButton</onlineImage>
8 <perAgentQueueLength>5</perAgentQueueLength>
9 <postchatPage>AnswersHome</postchatPage>
10 <prechatFormPage>AccountVF</prechatFormPage>
11 <pushTimeOut>300</pushTimeOut>
12 <routingType>LeastActive</routingType>
13 <site>LiveAgentSite</site>
14 <skills>
15 <skill>Skill1</skill>
16 <skill>Skill2</skill>
17 </skills>
18</LiveChatButton>