addButtonEventHandler
addButtonEventHandler メソッドは、特定のイベントが発生したときのチャットボタンの動作を定義するために使用します。API バージョン 28.0 以降で使用できます。
使用方法
次のイベントが発生したときのチャットボタンの動作を定義します。
- チャットに対応できるエージェントがいる。
- チャットに対応できるエージェントがいない。
「チャットに対応できるエージェントがいない」というイベントは、設定したチャットボタンを使用してチャットをエージェントに届けることができない場合に発生します。このイベントは次の場合に発生します。
- エージェントがオンラインになっていない。
- ボタンに関連付けられているスキルに割り当てられたエージェントがオンラインになっていない。
- オンラインのエージェントの状況が [不在] になっている。
- オンラインのエージェントがフル (Live Agent 設定またはオムニチャネルを使用したプレゼンス設定で指定) になっている。
- オンラインのエージェントがオムニチャネルを使用しているが、他のサービスチャネルにのみ対応できる。
構文
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 | エージェントがチャットに対応できない場合のボタンの動作を指定します。 |