チャット REST API 開発者ガイド
jチャット REST API のレスポンスボディ
チャット REST API リソースへの要求では、応答コードが返されます。リソース要求の実行が成功すると、JSON 形式でレスポンスボディが返される場合もあります。
Availability
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン results Result オブジェクトの配列 エージェントやチャットボタンに対応する Salesforce ID と、新しいチャット要求を受信できるかどうかのリスト。 29.0 - レスポンスボディ
-
ChasitorSessionData
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン queuePosition integer チャットキュー内のチャット訪問者の位置。 29.0 geoLocation GeoLocation オブジェクト 要求が開始された IP アドレスに基づく、チャット訪問者の場所。 29.0 url String チャット訪問者がアクセスしている URL。 29.0 oref String チャット要求の開始元の URL。 29.0 postChatUrl String チャットの終了後にチャット訪問者がリダイレクトされる URL。 29.0 sneakPeekEnabled Boolean チャットを受け入れたエージェントのプレビューが有効になっているかどうか。 29.0 chatMessages TranscriptEntry オブジェクトの配列 agent.js ファイルと chasitor.js ファイルで同期するチャットメッセージの構造。 29.0 - レスポンスボディ
-
ChasitorIdleTimeoutWarningEvent
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン idleTimeoutWarningEvent String 警告のトリガ時またはクリア時にサーバに通知します。可能な値は、triggered と cleared です。 35.0
ChatEstablished
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン name String チャットに参加しているエージェントの名前。 29.0 userId String チャットに参加しているエージェントのユーザ ID。 29.0 sneakPeekEnabled Boolean チャットを受け入れたエージェントのプレビューが有効になっているかどうか。 29.0 chasitorIdletimeout ChasitorIdleTimeoutSettings 訪問者のアイドルタイムアウトの設定。 35.0 - レスポンスボディ
-
ChatMessage
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン name String チャットに参加しているエージェントの名前。 29.0 text String エージェントがチャット訪問者に送信したチャットメッセージのテキスト。 29.0 - レスポンスボディ
-
ChatRequestFail
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン reason String チャット要求が失敗した理由 (どのエージェントもチャットすることができなかった、内部エラーが発生したなど)。 29.0 postChatUrl String チャットの終了後にチャット訪問者がリダイレクトされる事後チャットページの URL。 29.0 - レスポンスボディ
-
ChatRequestSuccess
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン queuePosition integer チャットキュー内のチャット訪問者の位置。 29.0 estimatedWaitTime number ボタンの予想待ち時間 (単位: 秒)。サーバが待ち時間を取得できない場合、このプロパティは -1 を返します。 47.0 geoLocation GeoLocation オブジェクト 要求が開始された IP アドレスに基づく、チャット訪問者の場所。 29.0 url String チャット訪問者がアクセスしている URL。 29.0 oref String チャット要求の開始元の URL。 29.0 postChatUrl String チャットの終了後にチャット訪問者がリダイレクトされる URL。 29.0 customDetails CustomDetail オブジェクトの配列 チャット要求が開始されたリリースのカスタム詳細。 29.0 visitorId String チャット訪問者の ID。 29.0 - レスポンスボディ
-
ChatTransferred
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン name String チャットの転送先のエージェントの名前。 29.0 userId String チャット訪問者の ID。 29.0 sneakPeekEnabled Boolean チャットの転送先のエージェントのプレビューが有効になっているかどうか。 29.0 chasitorIdletimeout ChasitorIdleTimeoutSettings 訪問者のアイドルタイムアウトの設定。 35.0 - レスポンスボディ
-
CustomEvent
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン type String 発生したカスタムイベントのタイプ。チャット訪問者側のイベントリスナーを追加するために使用されます。 29.0 data String チャット訪問者に送信されたイベントに関連するデータ。 29.0 - レスポンスボディ
-
Messages
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン messages Message オブジェクトの配列 チャット中に送信されたメッセージ。 29.0 offset integer クライアントが受信したメッセージを追跡する ReconnectSession 要求で使用される内部番号。 29.0 sequence integer チャット中に受信したメッセージの順序。 29.0 - レスポンスボディ
-
NewVisitorBreadcrumb
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン location String チャット訪問者が表示している Web ページの URL。 29.0 - レスポンスボディ
-
QueueUpdate
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン position integer チャットキュー内のチャット訪問者の更新された位置。 29.0 estimatedWaitTime number ボタンの予想待ち時間 (単位: 秒)。サーバが待ち時間を取得できない場合、このプロパティは -1 を返します。 47.0 - レスポンスボディ
-
ReconnectSession
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン resetSequence Boolean true の場合、次の要求のシーケンスはリセットする必要があります。 37.0 affinityToken String 今後のすべての要求のヘッダーで渡される、セッションのアフィニティトークン。 37.0 - レスポンスボディ
-
SessionId
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン id String 新しいセッションのセッション ID。 29.0 key String 新しいセッションのセッションキー。 29.0 affinityToken String 今後のすべての要求のヘッダーで渡される、セッションのアフィニティトークン。 29.0 clientPollTimeout integer Messages 要求の実行期限 (秒数)。この期限内に実行しないと、Messages long polling ループがタイムアウトして終了します。 29.0 - レスポンスボディ
-
Settings
- 応答プロパティ
-
プロパティ名 型 説明 使用可能なバージョン pingrate number チャット訪問者セッションを維持するために訪問者がサーバに ping する必要のある頻度。 29.0 contentServerUrl String コンテンツサーバの URL。 29.0 buttons button オブジェクトの配列 Settings 要求の実行時に指定した、チャットボタンとその設定情報のリスト。 29.0 - レスポンスボディ
-