Salesforce コンソールインテグレーションツールキット開発者ガイド
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
getDetailsByChatKey()
構文
引数
| 名前 | 型 | 説明 |
|---|---|---|
| chatKey | String | 詳細を取得するチャットに関連付けられた chatKey。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |
サンプルコード – Visualforce
応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次のプロパティが含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| primaryTabId | String | チャットに関連付けられた主タブの ID。 |
| details | Object | 特定の主タブに関連付けられたチャットのすべての詳細を含むオブジェクト。 |
| success | Boolean | 詳細が正常に取得された場合は true、詳細が正常に取得されなかった場合は false。 |
details
details オブジェクトには次のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| acceptTime | Date/Time | エージェントがチャット要求を受け入れた日時。 |
| breadcrumbs | breadcrumb オブジェクトの配列 | チャット前およびチャット中に訪問者が訪れた Web ページのリストを表す breadcrumb オブジェクトの配列。 |
| chatKey | String | チャットに関連付けられたチャットキー。 |
| customDetails | customDetail オブジェクトの配列 | リリース API または事前チャットフォーム API でこのチャットに渡されたカスタム詳細を表す customDetail オブジェクトの配列。 |
| geoLocation | Object | チャット訪問者の IP アドレスの geoIP ルックアップによって取得された、チャット訪問者の場所の詳細を表すオブジェクト。 |
| ipAddress | String | チャット訪問者の IP アドレス (ドット付き 10 進数形式)。 |
| isEnded | Boolean | チャットが終了したか (true)、否か (false) を示します。 |
| isEngaged | Boolean | 現在参加しているチャットか (true)、否か (false) を示します。 |
| isPushRequest | Boolean | プッシュベースの転送方法 ([最も利用されていない] や [最も利用されている] など) でチャットがエージェントに転送されたか (true)、否か (false) を示します。 |
| isTransferringOut | Boolean | チャットが現在別のエージェントに転送中か (true)、否か (false) を示します。 |
| liveChatButtonId | String | チャット要求が行われたチャットボタンの 15 桁のレコード ID。 |
| liveChatDeploymentId | String | チャット要求が行われたリリースの 15 桁のレコード ID。 |
| name | String | チャット訪問者の名前。 |
| requestTime | Date/Time | チャットの要求日時。 |
| visitorInfo | Object | 訪問者の Web ブラウザに関する情報を含むオブジェクト。 |
breadcrumb
ブレッドクラムは、チャット訪問者が参照した Web ページを表します。breadcrumb オブジェクトには次のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| location | String | チャット訪問者が参照した Web ページの URL。 |
| time | Date/Time | チャット訪問者が特定のブレッドクラムの URL を訪れた日時。 |
customDetail
カスタム詳細は、リリース API または事前チャットフォーム API でチャットに渡された詳細です。customDetail オブジェクトには次のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| label | String | リリース API または事前チャットフォーム API で指定されたカスタム詳細の名前。 |
| value | String | リリース API または事前チャットフォーム API で指定されたカスタム詳細の値。 |
| transcriptFields | String の配列 | チャットトランスクリプトの顧客の詳細が保存される項目の名前。 |
| entityMaps | entityMap オブジェクトの配列 | カスタム詳細情報の対応付けに使用される、事前に作成されたレコードの配列。 |
entityMap
エンティティは、顧客がエージェントとチャットを開始するときに作成されるレコードです。API を使用して、これらのレコードに顧客の詳細を自動入力できます。entityMap オブジェクトには次のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| entityName | String | 検索または作成するレコード。 |
| fieldName | String | 詳細に関連付けられた項目の名前。 |
| isFastFillable | Boolean | エージェントがレコードを作成または編集するときに値を使用して項目を入力できるか (true)、否か (false) を示します (Live Agent コンソールのみ)。 |
| isAutoQueryable | Boolean | Live Agent コンソールを使用している場合、値を含む fieldName があるレコードを検索するために (Live Agent コンソールで) SOSL クエリを実行するか (true)、否か (false) を示します。 Salesforce コンソールを使用している場合、値を含む fieldName があるレコードを検索するために (Salesforce コンソールで) SOQL クエリを実行するか (true)、否か (false) を示します。 |
| isExactMatchable | Boolean | 項目 fieldName に完全一致する項目があるレコードのみを検索するか (true)、否か (false) を示します。 |
geoLocation
geoLocation オブジェクトは、チャット訪問者の場所の詳細を表します。次のプロパティが含まれています。
| プロパティ | 型 | 説明 |
|---|---|---|
| city | String | チャット訪問者の市区郡の名前。 |
| countryCode | String | チャット訪問者の国に対応する 2 桁の ISO-3166 国コード。 |
| countryName | String | チャット訪問者の国の名前。 |
| latitude | String | チャット訪問者のおおよその緯度。 |
| longitude | String | チャット訪問者のおおよその経度。 |
| organization | String | チャット訪問者のインターネットサービスプロバイダの組織名。 |
| region | String | チャット訪問者の地域 (都道府県など)。 |
visitorInfo
visitorInfo オブジェクトは、訪問者の Web ブラウザに関する情報を表します。次のプロパティが含まれています。
| プロパティ | 型 | 説明 |
|---|---|---|
| browserName | String | チャット訪問者の Web ブラウザの名前およびバージョン。 |
| language | String | チャット訪問者の Web ブラウザの言語。 |
| originalReferrer | String | チャット訪問者がチャットを要求した Web ページの元の URL。 |
| screenResolution | String | チャット訪問者のブラウザから渡される、チャット訪問者のコンピュータの画面解像度。 |
| sessionKey | String | 最終的にこの Live Chat の訪問者の一意の参照として LiveChatVisitor レコードに保存される訪問者のセッションキー。 |