Web 用組み込みサービス開発者ガイド
jチャットイベント通知の受信
特定のチャットイベントがトリガされた場合の通知を設定します。これらの特定のイベントに登録するには、組み込みチャットのコードスニペット内で embedded_svc.addEventHandler をコールします。
次のイベントは、JSON オブジェクトパラメータを指定���れたコールバックに渡します。コールバックには 1 つの属性が含まれます。
| eventName | シナリオ |
|---|---|
| onAgentJoinedConference | エージェントがチャット会議に参加すると起動されます。 |
| onAgentLeftConference | エージェントがチャット会議を退席すると起動されます。 |
| onAgentMessage | エージェントがメッセージを送信すると起動されます。 |
| onAgentRichMessage | チャットボットがリッチメッセージを送信すると起動されます。チャットボットはリッチメッセージとプレーンメッセージを組み合わせて送信します。 |
| onChasitorMessage | チャット訪問者がメッセージを送信すると起動されます。 |
| onChatConferenceEnded | チャット会議が終了すると起動されます。 |
| onChatConferenceInitiated | チャット会議が開始されると起動されます。 |
| onChatEndedByAgent | エージェントがチャットを終了すると起動されます。 |
| onChatEndedByChasitor | チャット訪問者がチャットを終了すると起動されます。 |
| onChatReconnectSuccessful | チャットの再接続が成功すると起動されます。 |
| onChatRequestSuccess | チャット要求が成功すると起動されます。 |
| onChatTransferSuccessful | チャット転送が成功すると起動されます。 |
| onConnectionError | エージェントへの接続が失われると起動されます。 |
| onIdleTimeoutClear | アイドルタイムアウト警告が表示された後に訪問者が応答すると起動されます。警告はクリアされます。 |
| onIdleTimeoutOccurred | 訪問者がアイドル状態になったためにチャットがタイムアウトすると起動されます。チャットは終了し、訪問者にはチャットが終了したというメッセージが表示されます。 |
| onIdleTimeoutWarningStart | [設定] の [[チャット] ボタンと招待] の [顧客のタイムアウト警告 (秒)] 項目で設定された時間が経過しても訪問者がエージェントに応答しないと起動されます。 |
| onQueueUpdate | 次の場合に起動されます。
|
次のクライアントに対するアプリケーションレベルの一般イベントはチャットセッション固有ではありませんが、チャット中に使用できます。これらのイベントでは、データはブロードキャストされません。
| eventName | シナリオ |
|---|---|
| afterMaximize | エンドユーザが最小化された状態をクリックすることで組み込みサービスチャットアプリケーションが最大化されると起動されます。 |
| afterDestroy | 組み込みサービスチャットが終了し、アプリケーションが閉じられると起動されます。 |
| afterMinimize | エンドユーザがチャットウィンドウヘッダーの最小化ボタンをクリックすることで組み込みサービスチャットアプリケーションが最小化されると起動されます。 |
| onClickSubmitButton | オフラインサポート UI コンポーネントの [送信] ボタンのクリックハンドラ。 |
| onHelpButtonClick | ヘルプボタンがクリックされたときに起動するコールバック。 |
| onInviteAccepted | 自動チャット招待を受け入れます。 |
| onInviteRejected | 自動チャット招待を却下します。 |
| onSettingsCallCompleted | getSettings コールが完了すると起動されます。コールは、ページ読み込み時に実行され、要求されたチャットボタンの設定を取得します。スニペットのボタンの最初のエージェント対応可能状況を含みます。 |
コード例
次のコードは、組み込みサービスチャットのコードスニペットでのこれらのイベントの使用例です。