各イベント定義
チャット機能の動作に伴い発生する各イベントの発生タイミングと定義は以下の通りです。
| イベント | 発生状況 | 備考 |
|---|---|---|
| message_open | チャットの接客サービスが表示された | 通常の接客サービスと同じロジックでイベントが発生。 |
| message_click | チャットの接客サービスがクリックされた | 通常の接客サービスと同じロジックでイベントが発生。 |
| talk_message_send | オペレーターのチャット発言 | 発言の都度、イベントが発生。 |
| message_reply | エンドユーザーのチャット発言 | 発言の都度、イベントが発生。 |
| _webchat_read | エンドユーザーのメッセージ未読・既読状況 | 各talk_message_sendイベントに対して、都度true(既読）/false（未読）の値が返される。 |
| _chat_open | チャットのLauncher（アイコン）が表示された | |
| _chat_close | チャットのLauncher（アイコン）が非表示になった | `options.enable_launcher_close:true` 時に「x」ボタンを押した場合も発生する |
| _chat_activate | チャットの ChatPanel （チャットウインドウ）が表示された | |
| _chat_deactivate | チャットの ChatPanel （チャットウインドウ）が非表示になった | |
| _talk_chat_status_changed | 会話のステータス変更 | 「KARTEトーク スレッドステータス変更」イベント。会話のステータスが対応中、返信待ち、対応済みに切り替える都度発生。 |
| _chat_message_reply_failed | エンドユーザーのチャット送信の失敗 | チャットでエンドユーザー側がメッセージ送信に失敗した場合に発生。 |
| _chat_connection_status_changed | エンドユーザーのチャットの接続状況が変化した | |
| accept_finish_conversation_request | 会話終了リクエストの「会話を終了」ボタン押下時 | |
| refuse_finish_conversation_request | 会話終了リクエストの「質問を続ける」ボタン押下時 | |
| _talk_log | チャットオペレーターのアサイン、チームのアサインなどが発生した時 | |
| _talk_chat_status_changed | チャットステータスの変更が発生した時 |
各イベントのパラメータ
主なイベント、パラメータについて記載しています。
talk_message_send
account: オペレータのID
message_id: メッセージのID
content.text: 発言内容
content.image: 添付画像のURL
date: タイムスタンプ
message_reply
message_id: メッセージのID
content.text: 発言内容
content.image: 添付画像のURL
date: タイムスタンプ
_talk_chat_status_changed
chatStatus: 対応中"open"、対応済み"closed"、返信待ち"waiting"
date: タイムスタンプ
_chat_connection_status_changed
connected: 非接続→接続"true"、接続→非接続"false"
date: タイムスタンプ