ライブ チャット SDK リファレンス
Customer Service 用オムニチャネルには、Dynamics 365 Customer Service Enterprise の機能を拡張する一連の機能が用意されていて、組織はデジタル メッセージング チャネルを通して顧客と即座につながり、やり取りできるようになります。 Customer Service 用オムニチャネルにアクセスする際は、追加のライセンスが必要です。 詳細については、Dynamics 365 Customer Service 価格の概要 と Dynamics 365 Customer Service 価格プラン ページを参照してください。
次の JavaScript の方法は、Customer Service 用オムニチャネルのライブ チャット ウィジェットでさまざまなアクションをおこなうのに使用できます。
メソッド
| メソッド | Description |
|---|---|
setContextProvider |
ライブ チャット チャネルのコンテキスト プロバイダーを設定します。 コンテキスト プロバイダー機能は、呼び出しがあった際にチャット セッションの初期化に使用されるコンテキストを戻します。 |
getContextProvider |
現在設定されているカスタム コンテキスト プロバイダーを必要に応じて取得します。 |
removeContextProvider |
現在設定されているカスタム コンテキスト プロバイダーを必要に応じて削除します。 |
setAuthTokenProvider |
認証のトークン プロバイダーの設定。 |
getAuthTokenProvider |
現在設定された認証のトークン プロバイダーを必要に応じて取得します。 |
removeAuthTokenProvider |
現在設定された認証のトークン プロバイダーを必要に応じて削除します。 |
startChat |
既存のチャットを必要に応じて開きます。 それ以外の場合は、新しいチャットを開始します。 メソッド内の customContext パラメータを使用してコンテキストを直接渡し、チャット セッションを初期化します |
startProactiveChat |
設定されたルールに基づいてチャットの会話に自動的に招待することで、組織がユーザーと関わることを可能にします。 |
closeChat |
エージェントと顧客の間での対話を終了します。 会話に関連するブラウザーのキャッシュも削除されます。 |
getAgentAvailability |
ルーティング規則に基づいて、キューのエージェントの可用性を取得します。 オムニチャネル開発者は、この API を使用して、会話の開始オプションを顧客に表示するかどうかを決定したり、待機時間やキュー内の位置などの情報を表示したりできます。 |
Events
| イベント | Description |
|---|---|
lcw:ready |
このイベントは、ライブ チャット SDK が使用可能な場合に実行されます。 |
lcw:error |
このイベントは、チャットの有効期間中にエラーが発生した場合に発生します。エラー コードとエラー メッセージの詳細については、 顧客サービス用オムニチャネルのエラー コード リファレンスを参照してください。 |
lcw:startChat |
このイベントはチャットに再参加されたときにトリガーされます。 |
lcw:closeChat |
このイベントはチャットが閉じられたときにトリガーされます。 |
lcw:chatQueued |
このイベントは、チャット会話が作成され開始された時に発生します。 |
lcw:chatRetrieved |
このイベントは、ページがリロードされた後、または別のタブで開かれた後に、システムが進行中のチャット会話をキャッシュから取得したときに発生します。 |
lcw:onClose |
このイベントは、チャット ウィジェットに参加している顧客がウィジェットを閉じたときにトリガーされます。 |
lcw:onMinimize |
このイベントは、チャット ウィジェットに参加している顧客がウィジェットを最小化したときにトリガーされます。 |
lcw:onMaximize |
このイベントは、チャット ウィジェットに参加している顧客がウィジェットを最大化したときにトリガーされます。 |
lcw:onMessageReceived |
このイベントは、チャット ウィジェットが新しいメッセージを受信したときにトリガーされます。 |
lcw:onMessageSent |
このイベントは、顧客がチャット ウィジェットに参加し、新規メッセージを送信した時にトリガーされます。 |
lcw:threadUpdate |
このイベントは、エージェントが会話を終了したときにライブ チャットによって発生します。 |
lcw:getAgentAvailability |
このイベントは、getAgentAvailability メソッドが応答に成功した時に発生します。 |