組み込みチャットでカスタムチャットイベントを作成できる API が 3 つあります。組み込みサービスコードスニペットのバージョン 5.0 以降で使用できます。
embedded_svc.liveagentAPI.sendCustomEvent()
顧客と現在チャットしているエージェントのエージェントコンソールにカスタムイベントを送信します。
表 1. 引数
| type |
string |
エージェントコンソールに送信するカスタムイベントの名前。 |
| data |
string |
カスタムイベントと共にエージェントコンソールに送信する追加データ。 |
embedded_svc.liveagentAPI.getCustomEvents()
このチャットセッション中にエージェントとチャット訪問者の両方から受信したカスタムイベントのリストを取得します。
表 2. 引数
| callback |
function |
メソッドの完了時にコールされる JavaScript メソッド。イベントの文字列を JSON 形式で渡します。 |
embedded_svc.liveagentAPI.addCustomEventListener()
チャットウィンドウにカスタムイベントが取得されるとコールされる関数を登録します。
表 3. 引数
| type |
string |
リスンするカスタムイベントのタイプ。 |
| callback |
function |
メソッドの完了時にコールされる JavaScript メソッド。type と data の 2 つの属性を持つオブジェクトを渡します。 |