Customer Service 用オムニチャネルには、Dynamics 365 Customer Service Enterprise の機能を拡張する一連の機能が用意されていて、組織はデジタル メッセージング チャネルを通して顧客と即座につながり、やり取りできるようになります。 Customer Service 用オムニチャネルにアクセスする際は、追加のライセンスが必要です。 詳細については、Dynamics 365 Customer Service 価格の概要 と Dynamics 365 Customer Service 価格プラン ページを参照してください。
ルーティング ルールに基づいてキューのエージェントの可用性を取得します。 オムニチャネル開発者は、この API を使用して、会話の開始オプションを顧客に表示するかどうかを決定したり、待ち時間やキュー内の位置などの情報を表示したりできます。
注
- ライブ チャット SDK メソッドを呼び出す前に、ライブ チャットによって発生した lcw:ready イベントをリッスンします。 ライブ チャット メソッドは、 lcw:ready イベントが発生した後に呼び出すことができます。 このイベントをリッスンするには、ウィンドウオブジェクトに独自のイベントリスナーを追加します。
- このメソッドは、顧客入力が変更されたときにクライアント側から複数回呼び出すことができます。 クライアント側のキャッシュは、2 分ごと、または顧客コンテキストパラメータが変更されたときに更新されます。
- このメソッドは、組織ごとに 1 分あたり 100 回のみ呼び出すことができます。 制限を超えると、指定された時間内に送信した要求が多すぎることを示す http 429 応答ステータスコードが表示されます。
構文
Microsoft.Omnichannel.LiveChatWidget.SDK.getAgentAvailability();
パラメーター
None
戻り値
| 名前 | タイプ | Description |
|---|---|---|
queueId |
String | ルーティングルールの設定と入力データに基づいてリクエストがルーティングされるターゲットキュー(ルーティングルールの一部であるエンティティの値とコンテキストが提供されます)。 |
isQueueAvailable |
ブール値 | 表示： - キューが営業時間内の場合は TRUE。 - キューが営業時間外の場合は FALSE。 |
StartTimeOfNextOperatingHour |
DateTime | キューが営業時間外の場合の営業時間の開始時刻 (UTC)。 稼働時間中は、値 01-01-0001 が返されます。 |
EndTimeOfNextOperatingHour |
DateTime | キューの営業時間が営業時間外の場合、キューの営業時間が終了する時刻 (UTC)。 稼働時間中は、値 01-01-0001 が返されます。 |
nexttransitiontime |
DateTime | キューが営業時間外の場合に再び動作する時刻 (UTC)。 キューが動作していない時間は、営業時間中に表示されます。 |
positionInQueue |
Number | 同じキュー内の他の顧客の後ろで待機している顧客のキュー内の位置。 |
isAgentAvailable |
ブール値 | 表示： - キュー内のエージェントが現在、ワークストリームに設定されたルーティングおよび割り当てルールに基づいて要求を受け取ることができる場合は TRUE。 API は、ボットがワークストリームまたはキューにアタッチされている場合も true を返します。 ボットが存在する場合は、この API を使用しないことをお勧めします。 - エージェントがリクエストを受け取ることができない場合は FALSE。 |
averageWaitTime |
Number | 過去 48 時間のデータに基づくターゲット キュー内の顧客の平均待機時間 (分単位)。 |
Example
window.addEventListener("lcw:ready", function handleLivechatReadyEvent(){
// Gets the agent availability
Microsoft.Omnichannel.LiveChatWidget.SDK.getAgentAvailability();
});
関数のカスタムコンテキスト値を渡して、コンテキストが受信されるようにします
このメソッドは、setContextProvider関数の内部呼び出しを実行し、getAgentAvailabilityを同期的に呼び出して、続行する前にコンテキストが設定されていることを確認します。 関数を個別に使用すると非同期であるため、コンサルティング・エージェントが使用可能なときにコンテキストの準備ができていない可能性があります。
注
getAgentAvailabilityを呼び出す前にsetContextProviderメソッドを呼び出す必要はありません。
setContextProvider メソッドの使用方法を示すサンプル コードを次に示します。
// To set the custom context, pass the custom context object as input parameter to agent availability
// provider as part of the logic, so there is no need to set custom context before this call.
Microsoft.Omnichannel.LiveChatWidget.SDK.getAgentAvailability({
customContext : {
'jwtToken': {'value':'token','isDisplayable':true},
'Email': {'value':'test@test.com','isDisplayable':true},
'client': {'value':'true','isDisplayable':true},
'Emailing': {'value':'true','isDisplayable':true}
}
}
);