Service Cloud チャット開発者ガイド
jaddButtonEventHandler
addButtonEventHandler メソッドは、特定のイベントが発生したときの自動招待の動作を定義するために使用します。
使用方法
次のイベントが発生したときの招待の動作を定義します。
- 招待が画面に表示されるための条件が満たされる。
- 招待が画面に表示されるための条件が満たされない。
- 顧客がチャットの招待を受諾する。
- 顧客がチャットの招待を却下する。
「招待が画面に表示されるための条件が満たされない」というイベントは、設定したチャットボタンまたは自動招待を使用してチャットをエージェントに届けることができない場合に発生します。このイベントは次の場合に発生します。
- エージェントがオンラインになっていない。
- ボタンに関連付けられているスキルに割り当てられたエージェントがオンラインになっていない。
- オンラインのエージェントの状況が [不在] になっている。
- オンラインのエージェントがフル (チャット設定またはオムニチャネルを使用したプレゼンス設定で指定) になっている。
- オンラインのエージェントがオムニチャネルを使用しているが、他のサービスチャネルにのみ対応できる。
API バージョン 28.0 以降で使用できます。
構文
void addButtonEventHandler(String buttonId, Function callback)
パラメータ
| 名前 | 型 | 説明 | 使用可能なバージョン |
|---|---|---|---|
| buttonId | String | 特定のイベントが発生したときの動作を定義する自動招待に関連付けられたチャットボタンの ID。 | API バージョン 28.0 以降で使用できます。 |
| callback | function | 特定のイベントが発生したときにコールする関数。必要なイベントタイプそれぞれに招待の動作を指定する必要があります。 | API バージョン 28.0 以降で使用できます。 |
イベントタイプ
次のイベントタイプを callback 関数に取り込み、特定のイベントが発生したときの招待の動作をカスタマイズします。次のイベントタイプそれぞれに招待の動作を指定する必要があります。
| 関数 | イベントタイプ | 構文 | 説明 |
|---|---|---|---|
| callback | BUTTON_AVAILABLE | liveagent.BUTTON_EVENT.BUTTON_AVAILABLE | 招待が画面に表示されるための条件が満たされた場合の自動招待の動作を指定します。 |
| BUTTON_UNAVAILABLE | liveagent.BUTTON_EVENT.BUTTON_UNAVAILABLE | 招待が画面に表示されるための条件が満たされていない場合の自動招待の動作を指定します。 | |
| BUTTON_ACCEPTED | liveagent.BUTTON_EVENT.BUTTON_ACCEPTED | 顧客が招待を受諾した場合の自動招待の動作を指定します。このイベント種別は、自動チャット招待でのみ使用できます。 | |
| BUTTON_REJECTED | liveagent.BUTTON_EVENT.BUTTON_REJECTED | 顧客が招待を却下した場合の自動招待の動作を指定します。このイベント種別は、自動チャット招待でのみ使用できます。 |