Web 用組み込みサービス開発者ガイド
j組み込みチャットセッションの開始、終了、クリア
3 つの API を使用することで、組み込みチャットのセッションを開始、終了、クリアできます。組み込みサービスコードスニペットのバージョン 5.0 以降を使用する必要があります。この API は、Lightning Locker が有効になっているコミュニティでは使用できません。
embedded_svc.liveAgentAPI.startChat(attributes);
チャット開始 API はウィジェットを起動し、チャット要求を初期化します。API に追加情報 (取引先責任者やケースの詳細) を渡すには、attributes オブジェクトを使用します。たとえば、指定したロジックに基づいて別の buttonId や特定の agentId に直接転送することができます。すべてのパラメータはオブジェクトとして渡す必要があります。コードは次のようになります。
チャットを開始するには、attributes オブジェクトに次の表のいずれかの組み込みサービスパラメータを含めます。
| 名前 | 型 | 説明 |
|---|---|---|
| directToAgentRouting | object |
エージェントへの直接転送は、チャット開始でのみサポートされます。
|
| prepopulatedPrechatFields | object |
「特定の事前チャットフォーム項目の自動入力の設定」を参照してください。 |
| extraPrechatInfo | array | 「非標準の事前チャット詳細を渡す」を参照してください。 |
| extraPrechatFormDetails | array | 「非標準の事前チャット詳細を渡す」を参照してください。 |
| fallbackRouting | array | 「転送順序の設定」を参照してください。 |
| directToButtonRouting | function | 「事前チャットの返答に基づくチャットの転送」を参照してください。 |
制限事項
- ウィジェットが最小化されていない場合、チャット開始によってウィジェットが最大化されます。エンドユーザが有効なチャットを要求中またはセッション中の場合は、API をコールしても別のチャット要求は開始されません。
- オフラインサポートではチャット開始属性がサポートされず、オフラインサポートフォームの事前入力やケースの送信は行われません。
- [対応可能なエージェントなし] ダイアログや [オフラインサポート] 状態でウィジェットが開かないようにするには、まず OnSettingsCallCompleted イベントを使用してエージェントが対応可能であることを確認します。
embedded_svc.liveAgentAPI.endChat();
チャット終了 API は現在のチャットを終了し (有効な場合)、チャットウィジェットを閉じます。有効なチャットリクエストや進行中のチャットセッションは (訪問者によって終了されたとして) 終了され、進行中のチャットセッションに関する組み込みサービスデータはクリアされます。必須パラメータはありません。
embedded_svc.liveAgentAPI.clearSession();
セッションクリア API は、すべてのチャット接続を終了し (有効な場合)、チャットウィジェットを閉じ、すべてのクライアント側チャットセッションに関するセッションデータを削除します。必須パラメータはありません。