チャット REST API 開発者ガイド
jSettings
チャットセッションに関連付けられている Live Agent リリースのすべての設定情報を取得します。Settings 要求は、チャット訪問者のセッションを確立するための最初の要求として必要になります。
構文
- URI
- https://hostname/chat/rest/Visitor/Settings
- 適用開始バージョン
- このリソースは API バージョン 29.0 以降で使用できます。
- 形式
- JSON
- HTTP メソッド
- GET
- 要求ヘッダー
- X-LIVEAGENT-API-VERSION
- 要求パラメータ
- なし
- クエリパラメータ
-
- org_id
- Live Agent リリースと関連付けられた Salesforce 組織の ID
- deployment_id
- チャット要求が開始された Live Agent リリースの ID。
- Settings.buttonIds
- 設定情報を取得するためのチャットボタン ID の配列。
- Settings.needEstimatedWaitTime
- estimatedWaitTime に入力する必要があるかどうかを示します。予想待ち時間を要求するには、1 の値を指定します。
- Settings.updateBreadcrumb
- 訪問者が表示している Web ページの URL で、チャット訪問者の場所を更新するかどうかを示します。
- リクエストボディ
- なし
- レスポンスボディ
- Settings 応答