getChatLog()
特定のチャットキーに関連付けられたチャットのチャットログを返します。API バージョン 29.0 以降で使用できます。
構文
引数
| 名前 | 型 | 説明 |
|---|---|---|
| chatKey | String | チャットログを取得するチャットに関連付けられた chatKey。 |
| callback | function | メソッドの完了時にコ��ルされる JavaScript メソッド。 |
サンプルコード – Visualforce
応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| customEvents | customEvent オブジェクトの配列 | チャット中に発生したカスタムイベントを表すカスタムイベントオブジェクトの配列。 |
| messages | message オブジェクトの配列 | チャットログのすべてのチャットメッセージを含むチャットメッセージオブジェクトの配列。 |
| success | Boolean | チャットログが正常に取得された場合は true、チャットログが正常に取得されなかった場合は false。 |
customEvent
customEvent オブジェクトには、チャットログの単一のイベントと次のプロパティが含まれます。
| プロパティ | 型 | 説明 |
|---|---|---|
| source | String | カスタムイベントを開始したユーザ (チャット訪問者またはエージェント)。 |
| type | String | 発生したカスタムイベントのタイプ。 |
| data | String | チャットに送信されたカスタムイベントのデータ。チャットウィンドウからこのイベントを送信するために使用された liveagent.chasitor.sendCustomEvent() メソッドの data 引数に対応します。 |
| timestamp | Date/Time | カスタムイベントの受信日時。 |